IsClipboardFormatAvailable

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function determines whether the clipboard contains data in the specified format.

Syntax

BOOL IsClipboardFormatAvailable(
  UINT format
); 

Parameters

• format
  [in] Unsigned integer that specifies a standard or registered clipboard format.

Return Value

Nonzero indicates that the clipboard format is available. Zero indicates that the clipboard format is not available. To get extended error information, call GetLastError.

Remarks

Typically, an application that recognizes only one clipboard format would call this function when processing the WM_INITMENUPOPUP message. The application would then enable or disable the Paste menu item, depending on the return value. Applications that recognize more than one clipboard format should use the GetPriorityClipboardFormat function for this purpose.

Requirements

See Also

Reference

CountClipboardFormats
EnumClipboardFormats
GetPriorityClipboardFormat
RegisterClipboardFormat
SetClipboardData
WM_INITMENUPOPUP
Clipboards Functions