Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xmclipboardcancelcopy(3) [centos man page]

XmClipboardCancelCopy(library call)									       XmClipboardCancelCopy(library call)

NAME
XmClipboardCancelCopy -- A clipboard function that cancels a copy to the clipboard SYNOPSIS
#include <Xm/CutPaste.h> int XmClipboardCancelCopy (display, window, item_id) Display * display; Window window; long item_id; (void) DESCRIPTION
XmClipboardCancelCopy cancels the copy to clipboard that is in progress and frees up temporary storage. When a copy is to be performed, XmClipboardStartCopy allocates temporary storage for the clipboard data. XmClipboardCopy copies the appropriate data into the the temporary storage. XmClipboardEndCopy copies the data to the clipboard structure and frees up the temporary storage structures. If XmClipboard- CancelCopy is called, the XmClipboardEndCopy function does not have to be called. A call to XmClipboardCancelCopy is valid only after a call to XmClipboardStartCopy. 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 through 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
XmClipboardSuccess The function was successful. XmClipboardLocked 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. XmClipboardFail The function failed because XmClipboardStartCopy was not called or because the data item contains too many formats. RELATED
XmClipboardCopy(3), XmClipboardEndCopy(3), and XmClipboardStartCopy(3). XmClipboardCancelCopy(library call)

Check Out this Related Man Page

XmClipboardEndCopy(library call)										  XmClipboardEndCopy(library call)

NAME
XmClipboardEndCopy -- A clipboard function that completes the copying of data to the clipboard SYNOPSIS
#include <Xm/CutPaste.h> int XmClipboardEndCopy (display, window, item_id) Display * display; Window window; long item_id; (void) 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 the window ID of a widget that relates the application window to the clipboard. The widget's window ID can be obtained through XtWindow. The same application instance should pass the same window ID to each clipboard function it calls. item_id Specifies the number assigned to this data item, which was returned by a previous call to XmClipboardStartCopy. RETURN
XmClipboardSuccess The function was successful. XmClipboardLocked 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. XmClipboardFail The function failed because XmClipboardStartCopy was not called. RELATED
XmClipboardCancelCopy(3), XmClipboardCopy(3) and XmClipboardStartCopy(3). XmClipboardEndCopy(library call)
Man Page