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


ClipboardObject.IDataObject.GetCanonicalFormatEtc - метод

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

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

Синтаксис

'Декларация
Private Function GetCanonicalFormatEtc ( _
    pformatectIn As FORMATETC(), _
    pformatetcOut As FORMATETC() _
) As Integer Implements IDataObject.GetCanonicalFormatEtc
int IDataObject.GetCanonicalFormatEtc(
    FORMATETC[] pformatectIn,
    FORMATETC[] pformatetcOut
)
private:
virtual int GetCanonicalFormatEtc(
    array<FORMATETC>^ pformatectIn, 
    array<FORMATETC>^ pformatetcOut
) sealed = IDataObject::GetCanonicalFormatEtc
private abstract GetCanonicalFormatEtc : 
        pformatectIn:FORMATETC[] * 
        pformatetcOut:FORMATETC[] -> int  
private override GetCanonicalFormatEtc : 
        pformatectIn:FORMATETC[] * 
        pformatetcOut:FORMATETC[] -> int
JScript не поддерживает явные реализации интерфейса.

Параметры

  • pformatectIn
    Тип: array<FORMATETC[]

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

  • pformatetcOut
    Тип: array<FORMATETC[]

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

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

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

Значение

Описание

S_OK

Структура возвращается FORMATETC отличается от одного, который был передан.

DATA_S_SAMEFORMATETC

Структуры FORMATETC совпадают и возвращается пустая ссылка в параметре pformatetcOut.

DV_E_LINDEX

Недопустимое значение для lindex; в настоящий момент поддерживается только значение -1.

DV_E_FORMATETC

Недопустимое значение для параметра pformatectIn.

OLE_E_NOTRUNNING

Приложение не выполняется.

Реализации

IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC)

Заметки

Если объект буфера обмена существующего экземпляра IDataObject (из пространства имен Microsoft.VisualStudio.OLE.Interop ), делегатов данного метода вызов соответствующего GetCanonicalFormatEtc из этого пространства имен. В противном случае он пытается преобразовать вызов GetCanonicalFormatEtc из пространства имен System.Runtime.InteropServices.ComTypes, если объект буфера обмена можно создать существующее IDataObject.

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

См. также

Ссылки

ClipboardObject Класс

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