Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

Syntax

UINT RegisterClipboardFormat(
  LPCWSTR 
lpszFormat
); 

Parameters

lpszFormat

[in] Long pointer to a null-terminated string that names the new format.

Return Value

The registered clipboard format indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

Windows Embedded CE supports only the Unicode version of RegisterClipboardFormat.

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.

Requirements

Header winuser.h
Library Clipbd.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also