IDataObject.GetCanonicalFormatEtc(IntPtr, IntPtr) IDataObject.GetCanonicalFormatEtc(IntPtr, IntPtr) IDataObject.GetCanonicalFormatEtc(IntPtr, IntPtr) IDataObject.GetCanonicalFormatEtc(IntPtr, IntPtr) Method

Definition

Retrieves a pointer to a standard FORMATETC structure that is logically equivalent to, but not necessarily equal to, the FORMATETC structure that is referenced by the a parameter.

public:
 int GetCanonicalFormatEtc(IntPtr a, IntPtr b);
public int GetCanonicalFormatEtc (IntPtr a, IntPtr b);
abstract member GetCanonicalFormatEtc : nativeint * nativeint -> int
Public Function GetCanonicalFormatEtc (a As IntPtr, b As IntPtr) As Integer

Parameters

a
IntPtr IntPtr IntPtr IntPtr

A pointer to the FORMATETC defining the format, medium, and target device for calls to retrieve data.

b
IntPtr IntPtr IntPtr IntPtr

An output pointer to a FORMATETC containing the most general information possible for a specific rendering or , if the GetCanonicalFormatEtc method returns DATA_S_SAMEFORMATETC.

Returns

The GetCanonicalFormatEtc method supports the standard return values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:

Return value Description
S_OK The returned FORMATETC is different from the structure passed in the parameters.
DATA_S_SAMEFORMATETC The returned FORMATETC is the same as the structure passed in the parameters and null is returned in b.
DV_E_LINDEX lindex is not valid.
DV_E_FORMATETC a is not valid.
OLE_E_NOTRUNNING The object application is not running.

Remarks

The GetCanonicalFormatEtc method allows the implementer of the IDataObject interface to return a canonical FORMATETC structure without duplicating the rendering logic for the FORMATETC structure.

For more information about programming with the IDataObject interface and the Microsoft Management Console (MMC), see the MMC Programmer's Guide.

Applies to