COleDataObject::GetData

BOOL GetData( CLIPFORMAT cfFormat, LPSTGMEDIUM lpStgMedium, LPFORMATETC lpFormatEtc = NULL );

Return Value

Nonzero if successful; otherwise 0.

Parameters

cfFormat

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

lpStgMedium

Points to a STGMEDIUM structure that will receive data.

lpFormatEtc

Points to a FORMATETC structure describing the format in which data is to be returned. Provide a value for this parameter 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 retrieve data from the item in the specified format.

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

For more information, see RegisterClipboardFormat in the Win32 documentation.

Example

See the example for CRichEditView::QueryAcceptData.

COleDataObject Overview | Class Members | Hierarchy Chart