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

NAME

6       XmClipboardEndCopy — A clipboard function that completes the copying of
7       data to the clipboard
8

SYNOPSIS

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

DESCRIPTION

18       XmClipboardEndCopy locks the clipboard from access  by  other  applica‐
19       tions,  places  data  in  the clipboard data structure, and unlocks the
20       clipboard.  Data items copied to the clipboard by  XmClipboardCopy  are
21       not  actually entered in the clipboard data structure until the call to
22       XmClipboardEndCopy.
23
24       This function also frees up temporary storage  that  was  allocated  by
25       XmClipboardStartCopy,  which  must be called before XmClipboardEndCopy.
26       The latter function should not be called if  XmClipboardCancelCopy  has
27       been called.
28
29       display   Specifies  a  pointer  to  the  Display  structure  that  was
30                 returned in a previous call to XOpenDisplay or XtDisplay.
31
32       window    Specifies the window ID of a widget that relates the applica‐
33                 tion  window  to the clipboard. The widget's window ID can be
34                 obtained through XtWindow.   The  same  application  instance
35                 should  pass the same window ID to each clipboard function it
36                 calls.
37
38       item_id   Specifies the number assigned to this data  item,  which  was
39                 returned by a previous call to XmClipboardStartCopy.
40

RETURN

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

57       XmClipboardCancelCopy(3),  XmClipboardCopy(3)   and   XmClipboardStart‐
58       Copy(3).
59
60
61
62                                              XmClipboardEndCopy(library call)
Impressum