GetPriorityClipboardFormat

  int GetPriorityClipboardFormat(puPriorityList, cList)    
  UINT *puPriorityList; /* address of priority list */
  int cList; /* count of entries in list */

This function returns the first clipboard format in a list for which data exist in the clipboard.

Parameters

puPriorityList

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

cList

Specifies the number of entries in puPriorityList. This value must not be greater than the actual 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