Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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_INITMENUPOPUPmessage. 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 GetPriorityClipboardFormatfunction for this purpose.

Requirements

Header winuser.h
Library Clipbd.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also