Share via


COleDataObject::GetGlobalData

Call this function to allocate a global memory block and to retrieve data in the specified format into an HGLOBAL.

HGLOBAL GetGlobalData( 
   CLIPFORMAT cfFormat, 
   LPFORMATETC lpFormatEtc = NULL  
);

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.

  • 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.

Return Value

The handle of the global memory block containing the data if successful; otherwise NULL.

Remarks

For more information, see FORMATETC in the Windows SDK.

For more information, see RegisterClipboardFormat in the Windows SDK.

Requirements

Header: afxole.h

See Also

Reference

COleDataObject Class

Hierarchy Chart

COleDataObject::GetData

COleDataObject::GetFileData

COleDataObject::IsDataAvailable