IsClipboardFormatAvailable

2.x

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

The IsClipboardFormatAvailable function specifies whether data of a certain format exists on the clipboard.

Parameters

uFormat

Specifies a registered clipboard format. For information about clipboard formats, see the description of the SetClipboardData function.

Return Value

The return value is nonzero if data of the specified format is on the clipboard. Otherwise, the return value is zero.

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 is present, the application typically enables the Paste command (in its Edit menu).