GetClipboardData

This function retrieves data from the clipboard in a specified format.

At a Glance

Header file: Winuser.h
Windows CE versions: 1.0 and later

Syntax

HANDLE GetClipboardData(UINT uFormat);

Parameters

uFormat

[in] Unsigned integer that specifies a clipboard format. For a description of the standard clipboard formats, see SetClipboardData.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

Windows CE does not support automatic data format conversions between clipboard formats.

An application can enumerate the available formats in advance by using the EnumClipboardFormats function.

The clipboard controls the handle that the GetClipboardData function returns, not the application. The application should copy the data immediately. The application cannot rely on being able to make long-term use of the handle. The application must not free the handle nor leave it locked.