'\" t
.\" ClipbJ.sgm /main/10 1996/09/25 10:24:43 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 "XmClipboardLock" 3
.SH "NAME"
\fBXmClipboardLock\fP \(em A clipboard function that locks the clipboard
"XmClipboardLock"
"clipboard functions" "XmClipboardLock"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/CutPaste\&.h>
int XmClipboardLock (\fIdisplay, window\fP)
        Display \fI* display\fP;
        Window  \fIwindow\fP;
\fB\fR(\fBvoid\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBXmClipboardLock\fP locks the clipboard from access by another
application until \fBXmClipboardUnlock\fP is called\&. All clipboard
functions lock and unlock the clipboard to prevent simultaneous
access\&. This function allows the application to keep the clipboard
data from changing between calls to \fBInquire\fP and
other clipboard functions\&. The application does not need to
lock the clipboard between calls to \fBXmClipboardStartCopy\fP and
\fBXmClipboardEndCopy\fP or to \fBXmClipboardStartRetrieve\fP and
\fBXmClipboardEndRetrieve\fP\&.
.PP
If the clipboard is already locked by another application,
\fBXmClipboardLock\fP returns an error status\&. Multiple calls to this
function by the same application increase the lock level\&.
.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\&.
.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\&.
.SH "RELATED"
.PP
\fBXmClipboardEndCopy\fP(3), \fBXmClipboardEndRetrieve\fP(3),
\fBXmClipboardStartCopy\fP(3), \fBXmClipboardStartRetrieve\fP(3), and
\fBXmClipboardUnlock\fP(3)\&.
.\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:18