This topic has not yet been rated - Rate this topic

GetPriorityClipboardFormat function

Applies to: desktop apps only

Retrieves the first available clipboard format in the specified list.

Syntax

Copy

int WINAPI GetPriorityClipboardFormat(
  __in  UINT *paFormatPriorityList,
  __in  int cFormats
);

Parameters

paFormatPriorityList [in]

Type: UINT*

The clipboard formats, in priority order. For a description of the standard clipboard formats, see Standard Clipboard Formats .

cFormats [in]

Type: int

The number of entries in the paFormatPriorityList array. This value must not be greater than the number of entries in the list.

Return value

Type: int

If the function succeeds, the return value is the first clipboard format in the list for which data is available. If the clipboard is empty, the return value is NULL. If the clipboard contains data, but not in any of the specified formats, the return value is –1. To get extended error information, call GetLastError.

Examples

For an example, see Example of a Clipboard Viewer.

Requirements