RegisterClipboardFormatA function

Registers a new clipboard format. This format can then be used as a valid clipboard format.

Syntax

UINT RegisterClipboardFormatA(
  LPCSTR lpszFormat
);

Parameters

lpszFormat

Type: LPCTSTR

The name of the new format.

Return Value

Type: UINT

If the function succeeds, the return value identifies the registered clipboard format.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If a registered format with the specified name already exists, a new format is not registered and the return value identifies the existing format. This enables more than one application to copy and paste data using the same registered clipboard format. Note that the format name comparison is case-insensitive.

Registered clipboard formats are identified by values in the range 0xC000 through 0xFFFF.

When registered clipboard formats are placed on or retrieved from the clipboard, they must be in the form of an HGLOBAL value.

Examples

For an example, see Registering a Clipboard Format.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

Clipboard

Conceptual

CountClipboardFormats

EnumClipboardFormats

GetClipboardFormatName

Reference