XmClipboardUnlock(3Xm) XmClipboardUnlock(3Xm)
NAME
XmClipboardUnlock - a clipboard function that unlocks
the clipboard.
AES SUPPORT LEVEL
full-use
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.
- 1 -
XmClipboardUnlock(3Xm) XmClipboardUnlock(3Xm)
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(3X), XmClipboardCopy(3X),
XmClipboardCopyByName(3X), XmClipboardEndCopy(3X),
XmClipboardEndRetrieve(3X),
XmClipboardInquireCount(3X),
XmClipboardInquireFormat(3X),
XmClipboardInquireLength(3X),
XmClipboardInquirePendingItems(3X),
XmClipboardLock(3X), XmClipboardRegisterFormat(3X),
XmClipboardRetrieve(3X), XmClipboardStartCopy(3X),
XmClipboardStartRetrieve(3X), XmClipboardUndoCopy(3X),
and XmClipboardWithdrawFormat(3X).
- 2 -