IsClipboardFormatAvailable

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

BOOL IsClipboardFormatAvailable(
UINT format); 

Parameters

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

Return Values

Nonzero indicates that the clipboard format is available. Zero indicates that If 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

Runs On Versions Defined in Include Link to
Windows CE OS 1.0 and later Winuser.h   Clipbd.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CountClipboardFormats, EnumClipboardFormats, GetPriorityClipboardFormat, RegisterClipboardFormat, SetClipboardData, WM_INITMENUPOPUP

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.