EnumClipboardFormats

2.x

	UINT EnumClipboardFormats(uFormat)
	UINT uFormat;	/* known clipboard format	*/

The EnumClipboardFormats function enumerates the formats found in a list of available formats that belong to the clipboard. Each call to this function specifies a known available format; the function returns the format that appears next in the list.

Parameters

uFormat

Specifies a known format. If this parameter is zero, the function returns the first format in the list.

Return Value

The return value specifies the next known clipboard data format if the function is successful. It is zero if the uFormat parameter specifies the last format in the list of available formats, or if the clipboard is not open.

Comments

Before it enumerates the formats by using the EnumClipboardFormats function, an application must open the clipboard by using the OpenClipboard function.

An application puts (or “donates”) alternative formats for the same data into the clipboard in the same order that the enumerator uses when returning them to the pasting application. The pasting application should use the first format enumerated in the list that it can handle. This gives the donor application an opportunity to recommend formats that involve the least loss of data.