DwtClipboardLock(3Dwt)

Name

DwtClipboardLock − Locks the clipboard from access by other applications.

Syntax

int DwtClipboardLock(display, window)
Display *display;
Window window;

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.

Description

The DwtClipboardLock function locks the clipboard from access by another application until you call DwtClipboardUnlock. All clipboard functions lock and unlock the clipboard to prevent simultaneous access. The DwtClipboardLock and DwtClipboardUnlock functions allow the application to keep the clipboard data from changing between calls to the inquire functions and other clipboard functions. The application does not need to lock the clipboard between calls to DwtBeginCopyToClipboard and DwtEndCopyToClipboard.

If the clipboard is already locked by another application, DwtClipboardLock returns an error status.

Multiple calls to DwtClipboardLock by the same application increase the lock level.

Return Value

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.