GetClipboardFormatName

2.x

  int GetClipboardFormatName(uFormat, lpszFormatName, cbMax)    
  UINT uFormat; /* format to retrieve, */  
  LPSTR lpszFormatName; /* address of buffer for name */
  int cbMax; /* length of name string */

The GetClipboardFormatName function retrieves the name of a registered clipboard format.

Parameters

uFormat

Specifies the registered format to retrieve. This parameter must not specify any of the predefined clipboard formats.

lpszFormatName

Points to a buffer that receives the format name.

cbMax

Specifies the maximum length, in bytes, of the format-name string. The format-name string is truncated if it is longer.

Return Value

The return value is the length, in bytes, of the returned format name if the function is successful. Otherwise, it is zero, indicating the requested format does not exist or is predefined.

See Also

CountClipboardFormats, EnumClipboardFormats, GetPriorityClipboardFormat, IsClipboardFormatAvailable, RegisterClipboardFormat