string = GetClipboardData(format)
The GetClipboardData function
retrieves data from the clipboard in a specified format. The clipboard
must have been opened previously. Note that not all data formats are supported,
and that the underlying handle can be retrieved with
win32clipboard::GetClipboardDataHandle
Parameters
format=CF_UNICODETEXT : int
Specifies a clipboard format. For a description of
the standard clipboard formats, see Standard Clipboard Formats.
Comments
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.
The system performs implicit data format conversions between certain
clipboard formats when an application calls the GetClipboardData function.
For example, if the CF_OEMTEXT format is on the clipboard, a window can
retrieve data in the CF_TEXT format. The format on the clipboard is
converted to the requested format on demand. For more information, see
Synthesized Clipboard Formats.
Win32 API References
Search for GetClipboardData at msdn, google or google groups.
Search for Standard Clipboard Formats at msdn, google or google groups.
To Do
CF_METAFILEPICT format returns a pointer to a METAFILEPICT struct which contains the metafile
handle,
rather than returning the handle directly. This code currently fails with
error: (6, 'GetClipboardData:GetMetafileBitsEx(NULL)', 'The handle is invalid.')
Return Value
If the function fails, the standard win32api.error exception
is raised. If the function succeeds, the return value is as
described in the following table:
|
Format
|
Result type
|
|
|
| CF_HDROP | A tuple of Unicode filenames. |
| CF_UNICODETEXT | A string object. |
| CF_OEMTEXT | A bytes object. |
| CF_TEXT | A bytes object. |
| CF_ENHMETAFILE | A string with binary data obtained from GetEnhMetaFileBits |
| CF_METAFILEPICT | A string with binary data obtained from GetMetaFileBitsEx (currently broken) |
| CF_BITMAP | An integer handle to the bitmap. |
| All other formats | A string with binary data obtained directly from the
global memory referenced by the handle. |