GetPriorityClipboardFormat function

Retrieves the first available clipboard format in the specified list.

Syntax

int GetPriorityClipboardFormat(
  UINT *paFormatPriorityList,
  int  cFormats
);

Parameters

paFormatPriorityList

Type: UINT*

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

cFormats

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.

Requirements

   
Windows version Windows 2000 Professional [desktop apps only] Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

Clipboard

Conceptual

CountClipboardFormats

EnumClipboardFormats

GetClipboardFormatName

IsClipboardFormatAvailable

Reference

RegisterClipboardFormat