Share via


GetClipboardData

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

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 Value

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

Remarks

Windows Embedded 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.

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

Reference

EnumClipboardFormats
SetClipboardData
Clipboards Functions