IOleObject::GetClipboardData

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves a data object that contains the current contents of the embedded object on which this method is called. Using the pointer to this data object, it is possible to create an embedded object with the same data as the original.

Syntax

HRESULT GetClipboardData( 
  DWORD dwReserved, 
  IDataObject** ppDataObject
);

Parameters

• dwReserved
  [in] Reserved for future use; set to zero.

• ppDataObject
  [out] Address of IDataObject* pointer variable that receives the interface pointer to the data object. If an error occurs, *ppDataObject must be set to NULL.

  Each time an object receives a call to GetClipboardData, it must increase the reference count on *ppDataObject.

  The caller is responsible to call IUnknown::Release when it is done with *ppDataObject.

Return Value

One of the values in the following table is returned.

Remarks

You can use the GetClipboardData method to convert a linked object to an embedded object, in which case the container application would call GetClipboardData and then pass the data received to OleCreateFromData.

This method returns a pointer to a data object that is identical to what would have been passed to the Clipboard by a standard copy operation.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Notes to Callers

If you want a stable snapshot of the current contents of an embedded object, call GetClipboardData.

If the data changes, you must call the function again for an updated snapshot.

If you want the caller to be informed of changes that occur to the data, call IUnknown::QueryInterface and then call IDataObject::DAdvise.

Notes to Implementers

If you implement this function, you must return an IDataObject pointer for an object whose data will not change.

Requirements

See Also

Reference

IOleObject
IDataObject
IDataObject::DAdvise
IUnknown::Release
IUnknown::QueryInterface

Concepts

Determining Supported COM APIs