COleDataObject::IsDataAvailable

BOOL IsDataAvailable( CLIPFORMAT cfFormat, LPFORMATETC lpFormatEtc = NULL );

Return Value

Nonzero if data is available in the specified format; otherwise 0.

Parameters

cfFormat

The Clipboard data format to be used in the structure pointed to by lpFormatEtc. This parameter can be one of the predefined Clipboard formats or the value returned by the native Windows RegisterClipboardFormat function.

lpFormatEtc

Points to a FORMATETC structure describing the format desired. Provide a value for this parameter only if you want to specify additional format information beyond the Clipboard format specified by cfFormat. If it is NULL, the default values are used for the other fields in the FORMATETC structure.

Remarks

Call this function to determine if a particular format is available for retrieving data from the OLE item. This function is useful before calling GetData, GetFileData, or GetGlobalData.

For more information, see IDataObject::QueryGetData and FORMATETC in the OLE 2 Programmer's Reference, Volume 1.

For more information, see RegisterClipboardFormat in the Win32 documentation.

COleDataObject OverviewClass MembersHierarchy Chart

See Also   COleDataObject::BeginEnumFormats, COleDataObject::GetData, COleDataObject::GetFileData, COleDataObject::GetGlobalData, COleDataObject::GetNextFormat