OleIsCurrentClipboard function (ole2.h)
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
[in] 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 |
|---|---|
|
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
| Requirement | Value |
|---|---|
| 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 |
| API set | ext-ms-win-com-ole32-l1-1-5 (introduced in Windows 10, version 10.0.15063) |