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

NAME

6       XmClipboardInquireFormat  —  A clipboard function that returns a speci‐
7       fied format name
8

SYNOPSIS

10       #include <Xm/CutPaste.h>
11       int XmClipboardInquireFormat (display, window, index, format_name_buf,
12               buffer_len, copied_len)
13               Display * display;
14               Window  window;
15               int     index;
16               XtPointer       format_name_buf;
17               unsigned long   buffer_len;
18               unsigned long   * copied_len;
19       (void)
20

DESCRIPTION

22       XmClipboardInquireFormat returns a specified format name for  the  data
23       item  in  the  clipboard.  If  the name must be truncated, the function
24       returns a warning status.
25
26       display   Specifies  a  pointer  to  the  Display  structure  that  was
27                 returned in a previous call to XOpenDisplay or XtDisplay.
28
29       window    Specifies the window ID of a widget that relates the applica‐
30                 tion window to the clipboard. The widget's window ID  can  be
31                 obtained  through  XtWindow.   The  same application instance
32                 should pass the same window ID to each of the clipboard func‐
33                 tions that it calls.
34
35       index     Specifies  which  of  the  ordered format names to obtain. If
36                 this index is greater than the number of formats for the data
37                 item,  this  function  returns  a  0 (zero) in the copied_len
38                 argument.
39
40       format_name_buf
41                 Specifies the buffer that receives the format name.
42
43       buffer_len
44                 Specifies the number of bytes in the format name buffer.
45
46       copied_len
47                 Specifies the number of bytes in the data item copied to  the
48                 buffer.   If  this  argument equals 0 (zero), there is no nth
49                 format for the data item.
50

RETURN

52       XmClipboardSuccess
53                 The function was successful.
54
55       XmClipboardLocked
56                 The function failed  because  the  clipboard  was  locked  by
57                 another application. The application can continue to call the
58                 function again with the same parameters until the  lock  goes
59                 away.  This  gives  the application the opportunity to ask if
60                 the user wants to keep trying or to give up on the operation.
61
62       XmClipboardTruncate
63                 The data returned is truncated because the user did not  pro‐
64                 vide a buffer large enough to hold the data.
65
66       XmClipboardNoData
67                 The function could not find data on the clipboard correspond‐
68                 ing to the format requested.  This could  occur  because  the
69                 clipboard  is  empty; there is data on the clipboard, but not
70                 in the requested format; or the data in the requested  format
71                 was passed by name and is no longer available.
72

74       XmClipboardStartCopy(3).
75
76
77
78                                        XmClipboardInquireFormat(library call)
Impressum