GetPriorityClipboardFormat

3.0

  int GetPriorityClipboardFormat(lpuPriorityList, cEntries)    
  UINT FAR* lpuPriorityList; /* address of priority list */
  int cEntries; /* count of entries in list */

The GetPriorityClipboardFormat function retrieves the first clipboard format in a list for which data exists in the clipboard.

Parameters

lpuPriorityList

Points to an integer array that contains a list of clipboard formats in priority order. For a description of the data formats, see the description of the SetClipboardData function.

cEntries

Specifies the number of entries in the priority list. This value must not be greater than the number of entries in the list.

Return Value

The return value is the highest priority clipboard format in the list for which data exists. If no data exists in the clipboard, the return value is NULL. If data exists in the clipboard that does not match any format in the list, the return value is –1.

See Also

CountClipboardFormats, EnumClipboardFormats, GetClipboardFormatName, IsClipboardFormatAvailable, RegisterClipboardFormat, SetClipboardData