'\" t
...\" ClipbG.sgm /main/10 1996/09/25 10:24:20 cdedoc $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmClipboardInquireFormat" "library call"
.SH "NAME"
\fBXmClipboardInquireFormat\fP \(em A clipboard function that returns a specified format name
.iX "XmClipboardInquireFormat"
.iX "clipboard functions" "XmClipboardInquireFormat"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/CutPaste\&.h>
int XmClipboardInquireFormat (\fIdisplay, window, index, format_name_buf,
        buffer_len, copied_len\fP)
        Display \fI* display\fP;
        Window  \fIwindow\fP;
        int     \fIindex\fP;
        XtPointer       \fIformat_name_buf\fP;
        unsigned long   \fIbuffer_len\fP;
        unsigned long   \fI* copied_len\fP;
\fB\fR(\fBvoid\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBXmClipboardInquireFormat\fP returns a specified format name for the
data item in the clipboard\&. If the name must be truncated, the
function returns a warning status\&.
.IP "\fIdisplay\fP" 10
Specifies a pointer to the \fBDisplay\fR structure that was returned in a
previous call to \fBXOpenDisplay\fP or \fBXtDisplay\fP\&.
.IP "\fIwindow\fP" 10
Specifies the window ID of a widget that relates the application window to the
clipboard\&. The widget\&'s window ID can be obtained through
\fBXtWindow\fP\&.
The same application instance should pass the same window ID to each of the
clipboard functions that it calls\&.
.IP "\fIindex\fP" 10
Specifies which of the ordered format names to obtain\&. If this index
is greater than the number of formats for the data item,
this function returns a 0 (zero) in the \fIcopied_len\fP argument\&.
.IP "\fIformat_name_buf\fP" 10
Specifies the buffer that receives the format name\&.
.IP "\fIbuffer_len\fP" 10
Specifies the number of bytes in the format name buffer\&.
.IP "\fIcopied_len\fP" 10
Specifies the number of bytes in the
data item copied to the buffer\&.
If this
argument equals 0 (zero), there is no \fIn\fPth format for the data item\&.
.SH "RETURN"
.IP "\fBXmClipboardSuccess\fP" 10
The function was successful\&.
.IP "\fBXmClipboardLocked\fP" 10
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\&.
.IP "\fBXmClipboardTruncate\fP" 10
The data returned is truncated because the user did not provide a buffer
large enough to hold the data\&.
.IP "\fBXmClipboardNoData\fP" 10
The function could not find data on the clipboard corresponding to the
format requested\&.
This could occur because the clipboard 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\&.
.SH "RELATED"
.PP
\fBXmClipboardStartCopy\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:18