XmClipboardInquireFormat(3X)XmClipboardInquireFormat(3X)NAMEXmClipboardInquireFormat - A clipboard function that returns a speci‐
fied format name
SYNOPSIS
#include <Xm/Xm.h> #include <Xm/CutPaste.h>
int XmClipboardInquireFormat (display, window, index, format_name_buf,
buffer_len, copied_len)
Display * display;
Window window;
int index;
XtPointer format_name_buf;
unsigned long buffer_len;
unsigned long * copied_len;
DESCRIPTIONXmClipboardInquireFormat returns a specified format name for the data
item in the clipboard. If the name must be truncated, the function
returns a warning status. Specifies a pointer to the Display structure
that was returned in a previous call to XOpenDisplay or XtDisplay.
Specifies a widget's window ID that relates the application window to
the clipboard. The widget's window ID can be obtained by using XtWin‐
dow. The same application instance should pass the same window ID to
each of the clipboard functions that it calls. Specifies which of the
ordered format names to obtain. If this index is greater than the num‐
ber of formats for the data item, this function returns a zero in the
copied_len argument. Specifies the buffer that receives the format
name. Specifies the number of bytes in the format name buffer. Speci‐
fies the number of bytes in the string copied to the buffer. If this
argument equals zero, there is no nth format for the data item.
RETURN VALUE
The function is successful. The function failed because the clipboard
was locked by another application. The application can continue to
call the function again with the same parameters until the lock goes
away. This gives the application the opportunity to ask if the user
wants to keep trying or to give up on the operation. The data returned
is truncated because the user did not provide a buffer large enough to
hold the data. The function could not find data on the clipboard cor‐
responding to the format requested. This could occur because the clip‐
board is empty; there is data on the clipboard but not in the requested
format; or the data in the requested format was passed by name and is
no longer available.
SEE ALSOXmClipboardStartCopy(3X)XmClipboardInquireFormat(3X)
