'\" t
...\" ClipbH.sgm /main/10 1996/09/25 10:24:28 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 "XmClipboardInquireLength" "library call"
.SH "NAME"
\fBXmClipboardInquireLength\fP \(em A clipboard function that returns the length of the stored data
.iX "XmClipboardInquireLength"
.iX "clipboard functions" "XmClipboardInquireLength"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/CutPaste\&.h>
int XmClipboardInquireLength (\fIdisplay, window, format_name, length\fP)
        Display \fI* display\fP;
        Window  \fIwindow\fP;
        char    \fI* format_name\fP;
        unsigned long   \fI* length\fP;
\fB\fR(\fBvoid\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBXmClipboardInquireLength\fP returns the length of the data stored
under a specified format name for the clipboard data item\&. If no data
is found for the specified format, or if there is no item on the
clipboard, this function returns a value of 0
(zero) in the \fIlength\fP argument\&.
.PP
Any format passed by name is assumed to have \fIlength\fP passed in
a call to \fBXmClipboardCopy\fP, even though the data has not yet been
transferred to the clipboard in that format\&.
.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 "\fIformat_name\fP" 10
Specifies the name of the format for the data item\&.
.IP "\fIlength\fP" 10
Specifies the length of the next data item in the specified format\&. This
argument equals 0 (zero) if no data is found for the specified format,
or if there is no item on the clipboard\&.
.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 "\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
\fBXmClipboardCopy\fP(3) and \fBXmClipboardStartCopy\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:18