XmClipboardUnlock(Xm) UNIX System V
NAME
XmClipboardUnlock - a clipboard function that unlocks the
clipboard.
SYNOPSIS
#include <Xm/Xm.h>
#include <Xm/CutPaste.h>
int XmClipboardUnlock (display, window, remove_all_locks)
Display * display;
Window window;
Boolean remove_all_locks;
DESCRIPTION
XmClipboardUnlock unlocks the clipboard, enabling it to be
accessed by other applications.
If multiple calls to XmClipboardLock have occurred, then the
same number of calls to XmClipboardUnlock is necessary to
unlock the clipboard, unless remove_all_locks is set to
True.
The application should lock the clipboard before multiple
calls to XmClipboardCopyByName and should unlock the
clipboard after completion.
display Specifies a pointer to the Display structure
that was returned in a previous call to
XOpenDisplay or XtDisplay.
window Specifies a widget's window ID that relates the
application window to the clipboard. The
widget's window ID can be obtained by using
XtWindow. The same application instance should
pass the same window ID to each of the clipboard
functions that it calls.
remove_all_locks
Indicates that all nested locks should be
removed, when True. When False, indicates that
only one level of lock should be removed.
RETURN VALUE
ClipboardSuccess
The function is successful.
ClipboardLocked
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.
RELATED INFORMATION
XmClipboardCancelCopy(Xm), XmClipboardCopy(Xm),
XmClipboardCopyByName(Xm), XmClipboardEndCopy(Xm),
XmClipboardEndRetrieve(Xm), XmClipboardInquireCount(Xm),
XmClipboardInquireFormat(Xm), XmClipboardInquireLength(Xm),
XmClipboardInquirePendingItems(Xm), XmClipboardLock(Xm),
XmClipboardRegisterFormat(Xm), XmClipboardRetrieve(Xm),
XmClipboardStartCopy(Xm), XmClipboardStartRetrieve(Xm),
XmClipboardUndoCopy(Xm), and XmClipboardWithdrawFormat(Xm).
(printed 2/14/90) XmClipboardUnlock(Xm)