DataObject.IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC) Метод

Определение

Пространство имен:

System.Windows

Сборка:

PresentationCore.dll

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

 virtual int System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc(System::Runtime::InteropServices::ComTypes::FORMATETC % pformatetcIn, [Runtime::InteropServices::Out] System::Runtime::InteropServices::ComTypes::FORMATETC % pformatetcOut) = System::Runtime::InteropServices::ComTypes::IDataObject::GetCanonicalFormatEtc;

int IDataObject.GetCanonicalFormatEtc (ref System.Runtime.InteropServices.ComTypes.FORMATETC pformatetcIn, out System.Runtime.InteropServices.ComTypes.FORMATETC pformatetcOut);

abstract member System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc : FORMATETC * FORMATETC -> int
override this.System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc : FORMATETC * FORMATETC -> int

Function GetCanonicalFormatEtc (ByRef pformatetcIn As FORMATETC, ByRef pformatetcOut As FORMATETC) As Integer Implements IDataObject.GetCanonicalFormatEtc

Параметры

pformatetcIn

FORMATETC

Указатель на структуру FORMATETC, переданную ссылкой, определяющую формат, среду передачи и целевое устройство, которые вызывающий объект хотел бы использовать для извлечения данных в последующем вызове, например GetData(FORMATETC, STGMEDIUM). В этом случае элемент TYMED не важен и должен быть проигнорирован.

pformatetcOut

FORMATETC

При возвращении данного метода содержит указатель на структуру FORMATETC, которая содержит наиболее общие сведения для определенной отрисовки, делая его канонически эквивалентным formatetcIn. Вызывающий объект должен выделить эту структуру, а метод GetCanonicalFormatEtc(FORMATETC, FORMATETC) должен заполнить данные. Для извлечения данных в последующем вызове, например GetData(FORMATETC, STGMEDIUM), вызывающий объект использует предоставленное значение параметра formatOut, если предоставленное значение не равно null. Это значение равняется null, если метод возвращает DATA_S_SAMEFORMATETC. В этом случае элемент TYMED не важен и должен быть проигнорирован. Этот параметр передается неинициализированным.

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

Int32

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

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

Реализации

GetCanonicalFormatEtc(FORMATETC, FORMATETC)

Комментарии

Этот член представляет собой явную реализацию члена интерфейса. Он может использоваться, только если экземпляр DataObject приведен к типу интерфейса IDataObject.