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

NAME

6       XmClipboardStartRetrieve  —  A  clipboard  function  that  prepares  to
7       retrieve data from the clipboard
8

SYNOPSIS

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

DESCRIPTION

18       XmClipboardStartRetrieve tells the clipboard routines that the applica‐
19       tion  is  ready to start copying an item from the clipboard.  The clip‐
20       board is locked by this routine and stays locked  until  XmClipboardEn‐
21       dRetrieve  is  called. Between a call to XmClipboardStartRetrieve and a
22       call to XmClipboardEndRetrieve, multiple calls  to  XmClipboardRetrieve
23       with  the  same  format  name result in data being incrementally copied
24       from the  clipboard  until  the  data  in  that  format  has  all  been
25       retrieved.
26
27       A return value of XmClipboardTruncate from calls to XmClipboardRetrieve
28       indicates that more data remains to be copied in the given format.   It
29       is  recommended that any calls to the Inquire functions that the appli‐
30       cation needs to make to complete the copy from the  clipboard  be  made
31       between  the  call  to  XmClipboardStartRetrieve  and the first call to
32       XmClipboardRetrieve. This way, the application does not  need  to  call
33       XmClipboardLock and XmClipboardUnlock.
34
35       display   Specifies  a  pointer  to  the  Display  structure  that  was
36                 returned in a previous call to XOpenDisplay or XtDisplay.
37
38       window    Specifies the window ID of a widget that relates the applica‐
39                 tion  window  to the clipboard. The widget's window ID can be
40                 obtained through XtWindow.   The  same  application  instance
41                 should pass the same window ID to each of the clipboard func‐
42                 tions that it calls.
43
44       timestamp Specifies the time of the event that triggered the  copy.   A
45                 valid timestamp must be supplied; it is not sufficient to use
46                 CurrentTime.
47

RETURN

49       XmClipboardSuccess
50                 The function is successful.
51
52       XmClipboardLocked
53                 The function failed  because  the  clipboard  was  locked  by
54                 another application. The application can continue to call the
55                 function again with the same parameters until the  lock  goes
56                 away.  This  gives  the application the opportunity to ask if
57                 the user wants to keep trying or to give up on the operation.
58

60       XmClipboardEndRetrieve(3),   XmClipboardInquireCount(3),   XmClipboard‐
61       InquireFormat(3),       XmClipboardInquireLength(3),       XmClipboard‐
62       InquirePendingItems(3),   XmClipboardLock(3),   XmClipboardRetrieve(3),
63       XmClipboardStartCopy(3), and XmClipboardUnlock(3).
64
65
66
67                                        XmClipboardStartRetrieve(library call)
Impressum