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

NAME

6       XmClipboardInquireLength — A clipboard function that returns the length
7       of the stored data
8

SYNOPSIS

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

DESCRIPTION

19       XmClipboardInquireLength returns the length of the data stored under  a
20       specified  format name for the clipboard data item. If no data is found
21       for the specified format, or if there is no item on the clipboard, this
22       function returns a value of 0 (zero) in the length argument.
23
24       Any format passed by name is assumed to have length passed in a call to
25       XmClipboardCopy, even though the data has not yet been  transferred  to
26       the clipboard in that format.
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 the window ID of a widget that relates the applica‐
32                 tion  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       format_name
38                 Specifies the name of the format for the data item.
39
40       length    Specifies the length of the next data item in  the  specified
41                 format. This argument equals 0 (zero) if no data is found for
42                 the specified format, or if there is no  item  on  the  clip‐
43                 board.
44

RETURN

46       XmClipboardSuccess
47                 The function was successful.
48
49       XmClipboardLocked
50                 The  function  failed  because  the  clipboard  was locked by
51                 another application. The application can continue to call the
52                 function  again  with the same parameters until the lock goes
53                 away. This gives the application the opportunity  to  ask  if
54                 the user wants to keep trying or to give up on the operation.
55
56       XmClipboardNoData
57                 The function could not find data on the clipboard correspond‐
58                 ing to the format requested. This  could  occur  because  the
59                 clipboard  is  empty; there is data on the clipboard, but not
60                 in the requested format; or the data in the requested  format
61                 was passed by name and is no longer available.
62

64       XmClipboardCopy(3) and XmClipboardStartCopy(3).
65
66
67
68                                        XmClipboardInquireLength(library call)
Impressum