OleIsCurrentClipboard function

Determines whether the data object pointer previously placed on the clipboard by the OleSetClipboard function is still on the clipboard.

Syntax

HRESULT OleIsCurrentClipboard(
  IN LPDATAOBJECT pDataObj
);

Parameters

pDataObj

Pointer to the IDataObject interface on the data object containing clipboard data of interest, which the caller previously placed on the clipboard.

Return Value

This function returns S_OK on success. Other possible values include the following.

Return code Description
S_FALSE
The specified pointer is not on the clipboard.

Remarks

OleIsCurrentClipboard only works for the data object used in the OleSetClipboard function. It cannot be called by the consumer of the data object to determine if the object that was on the clipboard at the previous OleGetClipboard call is still on the clipboard.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ole2.h
Library Ole32.lib
DLL Ole32.dll

See Also

OleFlushClipboard

OleSetClipboard