IsClipboardFormatAvailable function (winuser.h)
Determines whether the clipboard contains data in the specified format.
Syntax
BOOL IsClipboardFormatAvailable(
[in] UINT format
);
Parameters
[in] format
Type: UINT
A standard or registered clipboard format. For a description of the standard clipboard formats, see Standard Clipboard Formats .
Return value
Type: BOOL
If the clipboard format is available, the return value is nonzero.
If the clipboard format is not available, the return value is zero. 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_INITMENU or 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.
Examples
For an example, see Pasting Information from 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 | winuser.h (include Windows.h) |
| Library | User32.lib |
| DLL | User32.dll |
| API set | ext-ms-win-ntuser-misc-l1-2-0 (introduced in Windows 8.1) |
See also
Conceptual
Reference