IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC) Metoda

Definice

Obor názvů:

System.Runtime.InteropServices.ComTypes

Sestavení:

System.Runtime.InteropServices.dll

Poskytuje standardní FORMATETC strukturu, která je logicky ekvivalentní složitější struktuře. Tato metoda slouží k určení, zda dvě různé FORMATETC struktury vrátí stejná data, čímž se odstraní nutnost duplicitního vykreslování.

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

Parametry

formatIn

FORMATETC

Ukazatel na FORMATETC strukturu předanou odkazem, který definuje formát, médium a cílové zařízení, které by volající chtěl použít k načtení dat v následném volání, jako GetData(FORMATETC, STGMEDIUM)je . Člen TYMED není v tomto případě významný a je třeba ho ignorovat.

formatOut

FORMATETC

Když se tato metoda vrátí, obsahuje ukazatel na FORMATETC strukturu, která obsahuje nejobecnější možné informace pro konkrétní vykreslování, takže je kanonicky ekvivalentní k formatetcIn. Volající musí tuto strukturu přidělit a GetCanonicalFormatEtc(FORMATETC, FORMATETC) metoda musí vyplnit data. K načtení dat v následném volání, jako GetData(FORMATETC, STGMEDIUM)je , použije volající zadanou hodnotu formatOut, pokud zadaná hodnota není null. Tato hodnota je null , pokud metoda vrátí DATA_S_SAMEFORMATETC. Člen TYMED není v tomto případě významný a je třeba ho ignorovat. Tento parametr se předává neinicializovaný.

Návraty

Int32

Tato metoda podporuje standardní návratové hodnoty E_INVALIDARG, E_UNEXPECTED a E_OUTOFMEMORY a také následující:

Hodnota	Popis
S_OK	FORMATETC Vrácená struktura se liší od té, která byla předána.
DATA_S_SAMEFORMATETC	Struktury FORMATETC jsou stejné a null vrátí se v parametru formatOut .
DV_E_LINDEX	Hodnota pro lindexje neplatná. V současné době se podporuje pouze hodnota -1.
DV_E_FORMATETC	Pro parametr je neplatná pFormatetc hodnota.
OLE_E_NOTRUNNING	Aplikace není spuštěná.

Poznámky

Další informace najdete v tématu Metoda IDataObject::GetCanonicalFormatEtc.