DwtCopyFromClipboard(3Dwt)

Name

DwtCopyFromClipboard − Retrieves a data item from the clipboard.

Syntax

int DwtCopyFromClipboard(display, window, format_name,
                         buffer, length,
                         num_bytes, private_id)
     Display *display;
     Window window;
     char *format_name;
     char *buffer;
     unsigned long length;
     unsigned long *num_bytes;
     int *private_id;

Arguments

displaySpecifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay. For information on XOpenDisplay and the Display structure, see the Guide to the Xlib Library: C Language Binding.

windowSpecifies the window ID that relates the application window to the clipboard. The same application instance should pass the same window ID to each clipboard function that it calls.

format_name
Specifies the name of a format in which the data is stored on the clipboard.

bufferSpecifies the buffer to which the application wants the clipboard to copy the data.

lengthSpecifies the length of the application buffer.

num_bytesSpecifies the number of bytes of data copied into the application buffer.

private_idSpecifies the private data stored with the data item by the application that placed the data item on the clipboard. If the application did not store private data with the data item, this argument returns zero.

Description

The DwtCopyFromClipboard function retrieves the current next-paste item from clipboard storage.

DwtCopyFromClipboard returns a warning under the following circumstances:

•The data needs to be truncated because the buffer length is too short

•The clipboard is locked

•There is no data on the clipboard

Return Value

This function returns one of these status return constants:

ClipboardSuccess	All data on the clipboard has been copied successfully. A successful copy can be a one-time operation using DwtCopyFromClipboard alone, or an incremental operation using multiple calls to DwtCopyFromClipboard between calls to DwtStartCopyFromClipboard and DwtEndCopyFromClipboard.
ClipboardLocked	The function failed because the clipboard was locked by another application. The application can continue to call the function with the same parameters until the clipboard is unlocked. Optionally, the application can ask if the user wants to keep trying or to give up on the operation.
ClipboardTruncate	If using DwtCopyFromClipboard alone, the data returned is truncated because the user did not provide a buffer that was large enough to hold the data. If using multiple calls to DwtCopyFromClipboard in between calls to DwtStartCopyFromClipboard and DwtEndCopyFromClipboard, more data in the requested format remains to be copied from the clipboard.
ClipboardNoData	The function could not find data on the clipboard corresponding to the format requested. This could occur because: (1) the clipboard is empty; (2) there is data on the clipboard but not in the requested format; and (3) the data in the requested format was passed by name and is no longer available.