int = EnumClipboardFormats(format)
The EnumClipboardFormats
function lets you enumerate the data formats that are currently available
on the clipboard.
Parameters
format=0 : int
Specifies a clipboard format that is known to be
available.
To start an enumeration of clipboard formats, set format to zero. When
format is zero, the function retrieves the first available clipboard
format. For subsequent calls during an enumeration, set format to the
result of the previous EnumClipboardFormat call.
Comments
Clipboard data formats are stored in an ordered list. To perform an
enumeration of clipboard data formats, you make a series of calls to the
EnumClipboardFormats function. For each call, the format parameter
specifies an available clipboard format, and the function returns the next
available clipboard format.
You must open the clipboard before enumerating its formats. Use the
OpenClipboard function to open the clipboard. The EnumClipboardFormats
function fails if the clipboard is not open.
The EnumClipboardFormats function enumerates formats in the order that
they were placed on the clipboard. If you are copying information to the
clipboard, add clipboard objects in order from the most descriptive
clipboard format to the least descriptive clipboard format. If you are
pasting information from the clipboard, retrieve the first clipboard
format that you can handle. That will be the most descriptive clipboard
format that you can handle.
The system provides automatic type conversions for certain clipboard
formats. In the case of such a format, this function enumerates the
specified format, then enumerates the formats to which it can be
converted. For more information, see Standard Clipboard Formats and
Synthesized Clipboard Formats.
Win32 API References
Search for EnumClipboardFormats at msdn, google or google groups.
Return Value
If the function succeeds, the return value is the clipboard
format that follows the specified format. In other words, the next
available clipboard format.
If there are no more clipboard formats to enumerate, the return value is
zero.
If the function fails, win32api.error is raised with the GetLastError
info.