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

NAME

6       XmClipboardEndRetrieve  — A clipboard function that completes retrieval
7       of data from the clipboard
8

SYNOPSIS

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

DESCRIPTION

17       XmClipboardEndRetrieve suspends copying  data  incrementally  from  the
18       clipboard.  It  tells  the  clipboard  routines that the application is
19       through copying an item from the  clipboard.  Until  this  function  is
20       called,  data  items  can be retrieved incrementally from the clipboard
21       with XmClipboardRetrieve.  The act of copying data is started with  the
22       XmClipboardStartRetrieve function.
23
24       display   Specifies  a  pointer  to  the  Display  structure  that  was
25                 returned in a previous call to XOpenDisplay or XtDisplay.
26
27       window    Specifies the window ID of a widget that relates the applica‐
28                 tion  window  to the clipboard. The widget's window ID can be
29                 obtained with XtWindow.  The same application instance should
30                 pass  the  same  window ID to each of the clipboard functions
31                 that it calls.
32

RETURN

34       XmClipboardSuccess
35                 The function was successful.
36
37       XmClipboardLocked
38                 The function failed  because  the  clipboard  was  locked  by
39                 another application. The application can continue to call the
40                 function again with the same parameters until the  lock  goes
41                 away.  This  gives  the application the opportunity to ask if
42                 the user wants to keep trying or to give up on the operation.
43

45       XmClipboardRetrieve(3),   XmClipboardStartCopy(3),   and   XmClipboard‐
46       StartRetrieve(3).
47
48
49
50                                          XmClipboardEndRetrieve(library call)
Impressum