XmClipboardCancelCopy(3X)

NAME
     XmClipboardCancelCopy  -- A  clipboard  function that cancels a copy to the
     clipboard

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

     int XmClipboardCancelCopy (display, window, item_id)
          Display   * display;
          Window    window;
          long      item_id;


VERSION
     This page documents version 1.2 of the Motif library.

DESCRIPTION
     XmClipboardCancelCopy cancels the copy to clipboard that is in progress and
     frees up temporary storage.  When a copy is to be  performed,  XmClipboard-
     StartCopy allocates temporary storage for the clipboard data.  XmClipboard-
     Copy  copies  the appropriate data into the the temporary storage.  XmClip-
     boardEndCopy copies the data to the clipboard structure and  frees  up  the
     temporary  storage structures.  If XmClipboardCancelCopy is called, the Xm-
     ClipboardEndCopy function does not have to be called.  A  call  to  XmClip-
     boardCancelCopy  is valid only after a call to XmClipboardStartCopy and be-
     fore a call to XmClipboardEndCopy.


     displaySpecifies 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 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.

     item_idSpecifies  the  number  assigned to this data item.  This number was
            returned by a previous call to XmClipboardStartCopy.


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.

     ClipboardFail
                 The function failed because XmClipboardStartCopy was not called
                 or because the data item contains too many formats.


RELATED INFORMATION
     XmClipboardCopy(3X), XmClipboardEndCopy(3X), and XmClipboardStartCopy(3X).

                                                       XmClipboardCancelCopy(3X)