XmClipboardEndCopy(3Xm) XmClipboardEndCopy(3Xm)
NAME
XmClipboardEndCopy - a clipboard function that ends a
copy to the clipboard.
AES SUPPORT LEVEL
full-use
SYNOPSIS
#include <Xm/Xm.h>
#include <Xm/CutPaste.h>
int XmClipboardEndCopy (display, window, item_id)
Display * display;
Window window;
long item_id;
DESCRIPTION
XmClipboardEndCopy 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 XmClipboardCopy are not
actually entered in the clipboard data structure until
the call to XmClipboardEndCopy.
This function also frees up temporary storage that was
allocated by XmClipboardStartCopy, which must be called
before XmClipboardEndCopy. The latter function should
not be called if XmClipboardCancelCopy has been called.
display Specifies a pointer to the Display
structure that was returned in a previous
call to XOpenDisplay or XtDisplay.
window Specifies a widget's window ID that relates
the application window to the clipboard.
The widget's window ID can be obtained by
using XtWindow. The same application
instance should pass the same window ID to
each of the clipboard functions that it
calls.
item_id Specifies the number assigned to this data
item. This number was returned by a
previous call to XmClipboardStartCopy.
RETURN VALUE
ClipboardSuccess
The function is successful.
- 1 -
XmClipboardEndCopy(3Xm) XmClipboardEndCopy(3Xm)
ClipboardLocked
The function failed because the clipboard
was locked by another application. The
application can continue to call the
function again with the same parameters
until the lock goes away. This gives the
application the opportunity to ask if the
user wants to keep trying or to give up on
the operation.
RELATED INFORMATION
XmClipboardCancelCopy(3X), XmClipboardCopy(3X) and
XmClipboardStartCopy(3X).
- 2 -