GetClipboardFormatName

int GetClipboardFormatName(wFormat, lpFormatName, cchFormatName)
UINT wFormat;	/* format to retrieve	*/
LPTSTR lpFormatName;	/* address of buffer for name	*/
int cchFormatName;	/* length of name string in characters	*/

This function retrieves from the clipboard the name of the registered format specified by the wFormat parameter. The name is copied to the buffer pointed to by the lpFormatName parameter.

Parameters

wFormat

Specifies the type of format to be retrieved. It must not specify any of the predefined clipboard formats.

lpFormatName

Points to the buffer that is to receive the format name.

cchFormatName

Specifies the maximum length (in characters) of the string to be copied to the buffer. If the actual name is longer, it is truncated.

Return Value

The return value specifies the actual length of the string (in characters) copied to the buffer. It is zero if the requested format does not exist or is a predefined format.

Comments

The GetClipboardFormatName function may be used as either a wide-character function (where text arguments must use Unicode) or an ANSI function (where text arguments must use characters from the Windows 3.x character set installed).