ClipboardObject.IDataObject.GetCanonicalFormatEtc - метод

Статья
11/01/2012

Предоставляет стандартную структуру 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
Тип: System.Runtime.InteropServices.ComTypes.FORMATETC%
Ссылка на структуру, FORMATETC передаваемое по ссылке, которая определяет формат, среду передачи и целевое устройство, которое вызывающий объект был хотел бы использовать для получения данных в последующем вызове, как IDataObject.GetData.В этом случае элемент tymed не важен и должен быть проигнорирован.

formatOut
Тип: System.Runtime.InteropServices.ComTypes.FORMATETC%
Когда этот метод возвращает управление, данный параметр содержит указатель на структуру FORMATETC, которая содержит общую информацию для определенной отрисовки, что делает возможной их канонически эквивалентно pformatectIn.Вызывающий объект должен выбрать эту структуру и метод GetCanonicalFormatEtc должен заполнять данные.Получение данных в последующем вызове IDataObject.GetData, как использовать вызывающего объекта указанное значение pformatetcOut, если указанное значение не будет nullссылка NULL (Nothing в Visual Basic).Это значение null, если метод возвращает DATA_S_SAMEFORMATETC.В этом случае элемент tymed не важен и должен быть проигнорирован.Этот параметр передается неинициализированным.

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

Тип: System.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 - пространство имен

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