Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

DwtClipboardUnlock(3Dwt)

Name

DwtClipboardUnlock − Unlocks the clipboard, enabling other applications to access it. 

Syntax

int DwtClipboardUnlock(display, window, remove_all_locks)
     Display *display;
     Window window;
     Boolean remove_all_locks;

Arguments

displaySpecifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay.  For information on XOpenDisplay and the Display structure, see the Guide to the Xlib Library: C Language Binding. 

windowSpecifies the window ID that relates the application window to the clipboard.  The same application instance should pass the same window ID to each clipboard function that it calls. 

remove_all_locks
Specifies a boolean value that, when True, indicates that all nested locks should be removed.  If False, indicates that only one level of lock should be removed. 

Description

The DwtClipboardUnlock function unlocks the clipboard, enabling it to be accessed by other applications. 

If multiple calls to DwtClipboardLock have occurred, then the same number of calls to DwtClipboardUnlock is necessary to unlock the clipboard, unless the remove_all_locks argument is True. 

Return Values

This function returns one of these status return constants:

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 with the same parameters until the clipboard is unlocked.  Optionally, the application can ask if the user wants to keep trying or to give up on the operation. 

See Also

DwtClipboardLock (3Dwt)
Guide to the XUI Toolkit: C Language Binding
Guide to the XUI Toolkit Intrinsics: C Language Binding

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026