Prev Next

GetClipboardFormatName info Overview Group

The GetClipboardFormatName function retrieves from the clipboard the name of the specified registered format. The function copies the name to the specified buffer.

int GetClipboardFormatName(

UINT format,	// clipboard format to retrieve
LPTSTR lpszFormatName,	// address of buffer for name
int cchMaxCount	// length of name string in characters
);

Parameters

format: Specifies the type of format to be retrieved. This parameter must not specify any of the predefined clipboard formats.
lpszFormatName: Points to the buffer that is to receive the format name.
cchMaxCount: Specifies the maximum length, in characters, of the string to be copied to the buffer. If the name exceeds this limit, it is truncated.

Return Values

If the function succeeds, the return value is the length, in characters, of the string copied to the buffer.

If the function fails, the return value is zero, indicating that the requested format does not exist or is predefined. To get extended error information, call GetLastError.

GetClipboardFormatName info Overview Group

Parameters

Return Values

See Also