DwtEndCopyToClipboard(3Dwt)

Name

DwtEndCopyToClipboard − Places data in the clipboard data structure.

Syntax

int DwtEndCopyToClipboard(display, window, item_id)
     Display *display;
     Window window;
     long item_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.

item_idSpecifies the number assigned to this data item. This number was returned by a previous call to DwtBeginCopyToClipboard.

Description

The DwtEndCopyToClipboard function locks the clipboard from access by other applications, places data in the clipboard data structure, and unlocks the clipboard. Data items copied to the clipboard by DwtCopyToClipboard are not actually entered in the clipboard data structure until the call to DwtEndCopyToClipboard.

Return Values

This function returns one of these status return constants:

ClipboardSuccess	The function is successful.
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.