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;
Windowwindow;
Booleanremove_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. 

displaySpecifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay. 

windowSpecifies 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(3Xm), XmClipboardCopy(3Xm), XmClipboardCopyByName(3Xm), XmClipboardEndCopy(3Xm), XmClipboardEndRetrieve(3Xm), XmClipboardInquireCount(3Xm), XmClipboardInquireFormat(3Xm), XmClipboardInquireLength(3Xm), XmClipboardInquirePendingItems(3Xm), XmClipboardLock(3Xm), XmClipboardRegisterFormat(3Xm), XmClipboardRetrieve(3Xm), XmClipboardStartCopy(3Xm), XmClipboardStartRetrieve(3Xm), XmClipboardUndoCopy(3Xm), and XmClipboardWithdrawFormat(3Xm). 

7th Edition