GetPriorityClipboardFormat
The GetPriorityClipboardFormat
function returns the first available clipboard format in the specified list.
int GetPriorityClipboardFormat(
|
UINT *paFormatPriorityList, |
// address of
priority list |
|
int cFormats |
// number of
entries in list |
|
); |
|
Parameters
paFormatPriorityList
Points to an
array of unsigned integers identifying clipboard formats, in priority order.
For a description of the clipboard formats, see the SetClipboardData function.
cFormats
Specifies the
number of entries in the paFormatPriorityList array. This value must not
be greater than the number of entries in the list.
Return Values
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.
See Also