COleDataObject Class

Used in data transfers for retrieving data in various formats from the Clipboard, through drag and drop, or from an embedded OLE item.

class COleDataObject

Members

Public Constructors

Name

Description

COleDataObject::COleDataObject

Constructs a COleDataObject object.

Public Methods

Name

Description

COleDataObject::Attach

Attaches the specified OLE data object to the COleDataObject.

COleDataObject::AttachClipboard

Attaches the data object that is on the Clipboard.

COleDataObject::BeginEnumFormats

Prepares for one or more subsequent GetNextFormat calls.

COleDataObject::Detach

Detaches the associated IDataObject object.

COleDataObject::GetData

Copies data from the attached OLE data object in a specified format.

COleDataObject::GetFileData

Copies data from the attached OLE data object into a CFile pointer in the specified format.

COleDataObject::GetGlobalData

Copies data from the attached OLE data object into an HGLOBAL in the specified format.

COleDataObject::GetNextFormat

Returns the next data format available.

COleDataObject::IsDataAvailable

Checks whether data is available in a specified format.

COleDataObject::Release

Detaches and releases the associated IDataObject object.

Remarks

COleDataObject does not have a base class.

These kinds of data transfers include a source and a destination. The data source is implemented as an object of the COleDataSource class. Whenever a destination application has data dropped in it or is asked to perform a paste operation from the Clipboard, an object of the COleDataObject class must be created.

This class enables you to determine whether the data exists in a specified format. You can also enumerate the available data formats or check whether a given format is available and then retrieve the data in the preferred format. Object retrieval can be accomplished in several different ways, including the use of a CFile, an HGLOBAL, or an STGMEDIUM structure.

For more information, see the STGMEDIUM structure in the Windows SDK.

For more information about using data objects in your application, see the article Data Objects and Data Sources (OLE).

Inheritance Hierarchy

COleDataObject

Requirements

Header: afxole.h

See Also

Reference

Hierarchy Chart

COleDataSource Class

COleClientItem Class

COleServerItem Class

COleDataSource::DoDragDrop

CView::OnDrop

Concepts

MFC Sample HIERSVR

MFC Sample OCLIENT