Museum

 XmClipboardEndRetrieve(Xm)     6 January 1993     XmClipboardEndRetrieve(Xm)


 Name

    XmClipboardEndRetrieve - a clipboard function that ends a copy from the
    clipboard

 Syntax


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

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


 Description

    XmClipboardEndRetrieve suspends copying data incrementally from the clip-
    board.  It tells the clipboard routines that the application is through
    copying an item from the clipboard. Until this function is called, data
    items can be retrieved incrementally from the clipboard by calling
    XmClipboardRetrieve.

    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

    XmClipboardRetrieve(Xm), XmClipboardStartCopy(Xm) and
    XmClipboardStartRetrieve(Xm).