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

Определение

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

System.Runtime.InteropServices.ComTypes

Сборки:

netstandard.dll, System.Runtime.InteropServices.dll

Исходный код:

IDataObject.cs

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

public:
 int GetCanonicalFormatEtc(System::Runtime::InteropServices::ComTypes::FORMATETC % formatIn, [Runtime::InteropServices::Out] System::Runtime::InteropServices::ComTypes::FORMATETC % formatOut);

public int GetCanonicalFormatEtc(ref System.Runtime.InteropServices.ComTypes.FORMATETC formatIn, out System.Runtime.InteropServices.ComTypes.FORMATETC formatOut);

abstract member GetCanonicalFormatEtc : FORMATETC * FORMATETC -> int

Public Function GetCanonicalFormatEtc (ByRef formatIn As FORMATETC, ByRef formatOut As FORMATETC) As Integer

Параметры

formatIn

FORMATETC

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

formatOut

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	Для параметра имеется недопустимое значение formatIn .
OLE_E_NOTRUNNING	Приложение не запущено.

Комментарии

Дополнительные сведения см. в методе IDataObject::GetCanonicalFormatEtc.