IsClipboardFormatAvailable

  BOOL IsClipboardFormatAvailable(wFormat)    
  UINT wFormat; /* registered clipboard format */

This function specifies whether data of a certain type exist in the clipboard.

Parameters

wFormat

Specifies a registered clipboard format. For information on clipboard formats, see the description of the SetClipboardData function, later in this chapter.

Return Value

The return value specifies the outcome of the function. It is TRUE if data having the specified format are present. Otherwise, it is FALSE.

Comments

This function is typically called during processing of the WM_INITMENU or WM_INITMENUPOPUP message to determine whether the clipboard contains data that the application can paste. If such data are present, the application typically enables the Paste command (in its Edit menu).

See Also

SetClipboardData, EnumClipboardFormats, CountClipboardFormats, RegisterClipboardFormat