1XmClipboardCancelCopy(library call)        XmClipboardCancelCopy(library call)
2
3
4

NAME

6       XmClipboardCancelCopy — A clipboard function that cancels a copy to the
7       clipboard
8

SYNOPSIS

10       #include <Xm/CutPaste.h>
11       int XmClipboardCancelCopy (display, window, item_id)
12               Display * display;
13               Window  window;
14               long    item_id;
15       (void)
16

DESCRIPTION

18       XmClipboardCancelCopy cancels the copy to clipboard that is in progress
19       and  frees  up  temporary  storage.   When  a  copy is to be performed,
20       XmClipboardStartCopy allocates  temporary  storage  for  the  clipboard
21       data.  XmClipboardCopy  copies the appropriate data into the the tempo‐
22       rary storage. XmClipboardEndCopy  copies  the  data  to  the  clipboard
23       structure  and  frees  up the temporary storage structures.  If XmClip‐
24       boardCancelCopy is called, the  XmClipboardEndCopy  function  does  not
25       have  to be called. A call to XmClipboardCancelCopy is valid only after
26       a call to XmClipboardStartCopy.
27
28       display   Specifies  a  pointer  to  the  Display  structure  that  was
29                 returned in a previous call to XOpenDisplay or XtDisplay.
30
31       window    Specifies  a  widget's window ID that relates the application
32                 window to the clipboard.   The  widget's  window  ID  can  be
33                 obtained  through  XtWindow.   The  same application instance
34                 should pass the same window ID to each of the clipboard func‐
35                 tions that it calls.
36
37       item_id   Specifies  the number assigned to this data item. This number
38                 was returned by a previous call to XmClipboardStartCopy.
39

RETURN

41       XmClipboardSuccess
42                 The function was successful.
43
44       XmClipboardLocked
45                 The function failed  because  the  clipboard  was  locked  by
46                 another application. The application can continue to call the
47                 function again with the same parameters until the  lock  goes
48                 away.  This  gives  the application the opportunity to ask if
49                 the user wants to keep trying or to give up on the operation.
50
51       XmClipboardFail
52                 The function  failed  because  XmClipboardStartCopy  was  not
53                 called or because the data item contains too many formats.
54

56       XmClipboardCopy(3), XmClipboardEndCopy(3), and XmClipboardStartCopy(3).
57
58
59
60                                           XmClipboardCancelCopy(library call)
Impressum