Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ XmClipboJ(Xm) — OpenDesktop Software Development System 3.0.0

Media Vault

Software Library

Restoration Projects

Artifacts Sought


 XmClipboardLock(Xm)            6 January 1993            XmClipboardLock(Xm)


 Name

    XmClipboardLock - a clipboard function that locks the clipboard

 Syntax


    #include <Xm/Xm.h>
    #include <Xm/CutPaste.h>

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


 Description

    XmClipboardLock locks the clipboard from access by another application
    until XmClipboardUnlock is called. All clipboard functions lock and
    unlock the clipboard to prevent simultaneous access. This function allows
    the application to keep the clipboard data from changing between calls to
    Inquire and other clipboard functions. The application does not need to
    lock the clipboard between calls to XmClipboardStartCopy and XmClipboar-
    dEndCopy or to XmClipboardStartRetrieve and XmClipboardEndRetrieve.

    If the clipboard is already locked by another application, XmClip-
    boardLock returns an error status. Multiple calls to this function by the
    same application increases the lock level.

    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 win-
            dow 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.

 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.

 See also

    XmClipboardEndCopy(Xm), XmClipboardEndRetrieve(Xm),
    XmClipboardStartCopy(Xm), XmClipboardStartRetrieve(Xm) and
    XmClipboardUnlock(Xm)


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