1XmClipboardInquirePendingItems(librXamrCylicpablola)rdInquirePendingItems(library call)
2
3
4

NAME

6       XmClipboardInquirePendingItems  —  A  clipboard function that returns a
7       list of data ID/private ID pairs
8

SYNOPSIS

10       #include <Xm/CutPaste.h>
11       int XmClipboardInquirePendingItems (display, window, format_name, item_list, count)
12               Display * display;
13               Window  window;
14               char    * format_name;
15               XmClipboardPendingList  * item_list;
16               unsigned long   * count;
17       (void)
18

DESCRIPTION

20       XmClipboardInquirePendingItems returns a list  of  data  ID/private  ID
21       pairs  for the specified format name. A data item is considered pending
22       if the application originally passed it by name,  the  application  has
23       not  yet  copied  the  data, and the item has not been deleted from the
24       clipboard.  The application is responsible for freeing the memory  pro‐
25       vided  by  this  function  to store the list.  To free the memory, call
26       XtFree.
27
28       This function is used by an application when exiting, to  determine  if
29       the data that is passed by name should be sent to the clipboard.
30
31       display   Specifies  a  pointer  to  the  Display  structure  that  was
32                 returned in a previous call to XOpenDisplay or XtDisplay.
33
34       window    Specifies the window ID of a widget that relates the applica‐
35                 tion  window  to the clipboard. The widget's window ID can be
36                 obtained through XtWindow.   The  same  application  instance
37                 should pass the same window ID to each of the clipboard func‐
38                 tions that it calls.
39
40       format_name
41                 Specifies a string that contains the name of the  format  for
42                 which the list of data ID/private ID pairs is to be obtained.
43
44       item_list Specifies  the  address  of  the  array of data ID/private ID
45                 pairs for the specified format name. This argument is a  type
46                 XmClipboardPendingList.   The  application is responsible for
47                 freeing the memory provided by this function for storing  the
48                 list.
49
50       count     Specifies  the number of items returned in the list. If there
51                 is no data for the specified format name, or if there  is  no
52                 item on the clipboard, this argument equals 0 (zero).
53

RETURN

55       XmClipboardSuccess
56                 The function was successful.
57
58       XmClipboardLocked
59                 The  function  failed  because  the  clipboard  was locked by
60                 another application. The application can continue to call the
61                 function  again  with the same parameters until the lock goes
62                 away. This gives the application the opportunity  to  ask  if
63                 the user wants to keep trying or to give up on the operation.
64

66       XmClipboardStartCopy(3).
67
68
69
70                                  XmClipboardInquirePendingItems(library call)
Impressum