ClipboardObject.IDataObject.GetCanonicalFormatEtc - метод

Статья
05/17/2015

Предоставляет стандартную структуру FORMATETC, которая логически эквивалентна более сложной структуре. Используйте этот метод, чтобы определить, возвращают ли 2 различных структур FORMATETC одни и те же данные, удаление потребность в дважды отрисовки.

Пространство имен: Microsoft.VisualStudio.Data.Framework
Сборка: Microsoft.VisualStudio.Data.Framework (в Microsoft.VisualStudio.Data.Framework.dll)

Синтаксис

'Декларация
Private Function GetCanonicalFormatEtc ( _
    ByRef formatIn As FORMATETC, _
    <OutAttribute> ByRef formatOut As FORMATETC _
) As Integer Implements IDataObject.GetCanonicalFormatEtc

int IDataObject.GetCanonicalFormatEtc(
    ref FORMATETC formatIn,
    out FORMATETC formatOut
)

private:
virtual int GetCanonicalFormatEtc(
    FORMATETC% formatIn, 
    [OutAttribute] FORMATETC% formatOut
) sealed = IDataObject::GetCanonicalFormatEtc

private abstract GetCanonicalFormatEtc : 
        formatIn:FORMATETC byref * 
        formatOut:FORMATETC byref -> int  
private override GetCanonicalFormatEtc : 
        formatIn:FORMATETC byref * 
        formatOut:FORMATETC byref -> int

JScript не поддерживает явные реализации интерфейса.

Параметры

formatIn
Тип: FORMATETC%

Ссылка на структуру FORMATETC, передаваемые по ссылке, которая определяет формат, носитель и целевое устройство, вызывающий код, который будет использоваться для получения данных в последующем вызове, например IDataObject.GetData. В этом случае элемент tymed не важен и должен быть проигнорирован.

formatOut
Тип: FORMATETC%

Если этот метод возвращает, этот параметр содержит указатель на структуру FORMATETC, содержащую наиболее общие сведения возможно для конкретной отрисовки, что делает его канонически эквивалент pformatectIn. Вызывающий объект должен выделять эту структуру и метод GetCanonicalFormatEtc должен заполнять данные. Для извлечения данных в последующем вызове например IDataObject.GetData, вызывающий объект используется значение, заданное pformatetcOut, если введено значение не будет nullссылка NULL (Nothing в Visual Basic). Это значение NULL, если метод возвращает DATA_S_SAMEFORMATETC. В этом случае элемент tymed не важен и должен быть проигнорирован. Этот параметр передается без инициализации.

Возвращаемое значение

Тип: Int32
Этот метод поддерживает стандартные возвращаемые значения E_INVALIDARG, E_UNEXPECTED и E_OUTOFMEMORY, так и следующее:

Значение	Описание
S_OK	Структура возвращается FORMATETC отличается от одного, который был передан.
DATA_S_SAMEFORMATETC	Структуры FORMATETC совпадают и возвращается пустая ссылка в параметре formatOut.
DV_E_LINDEX	Недопустимое значение для lindex; в настоящий момент поддерживается только значение -1.
DV_E_FORMATETC	Недопустимое значение для параметра formatIn.
OLE_E_NOTRUNNING	Приложение не выполняется.

Реализации

IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC)

Заметки

Этот метод делегирует вызов соответствующего GetCanonicalFormatEtc из пространства имен System.Runtime.InteropServices.ComTypes, высказывать объект буфера обмена существующего экземпляра IDataObject.

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Для получения дополнительной информации см. Использование библиотек из не вполне надежного кода.

См. также

Ссылки

ClipboardObject Класс

Microsoft.VisualStudio.Data.Framework - пространство имен

Поделиться через