...\" **  (c) Copyright 1993, 1994 Hewlett-Packard Company
...\" **  (c) Copyright 1993, 1994 International Business Machines Corp.
...\" **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
...\" **  (c) Copyright 1993, 1994 Novell, Inc
...\" **
...\" **
...\" **
...\" **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.
...\" **      All Rights Reserved.
...\" **
...\" **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company
...\" **
...\" **  (c) Copyright 1988 by Massachusetts Institute of Technology
...\" **
...\" **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,
...\" **      Maynard, MA.  All Rights Reserved.
...\" **
...\" **
.TH XmClipboardCancelCopy 3X "" "" "" ""
.ds )H Hewlett-Packard Company
.ds ]W Motif Release 1.2: May 1992
.SH NAME
\fIXmClipboardCancelCopy\fP \- A clipboard function that cancels a copy to the clipboard
.SH SYNOPSIS
.nf
.sS
.iS
\&#include <Xm/Xm.h>
\&#include <Xm/CutPaste.h>
.sp \n(PDu
int \fIXmClipboardCancelCopy\fI (\fBdisplay, window, item_id\fI)
.ta .5i 1.5i
.nf
	Display	\fB* display\fI;
	Window	\fBwindow\fI;
	long	\fBitem_id\fI;
.wH
.fi
.iE
.sE
.SH DESCRIPTION
.fi
\fIXmClipboardCancelCopy\fP
cancels the copy to clipboard that is in progress and
frees up temporary storage.
When a copy is to be performed, \fIXmClipboardStartCopy\fP allocates
temporary storage for the clipboard data.  \fIXmClipboardCopy\fP copies
the appropriate data into the the temporary storage.  \fIXmClipboardEndCopy\fP
copies the data to the clipboard structure and frees up the temporary
storage structures.
If \fIXmClipboardCancelCopy\fP is called, the
\fIXmClipboardEndCopy\fP function does not have to be called.  A call to
\fIXmClipboardCancelCopy\fP
is valid only after a call to \fIXmClipboardStartCopy\fP
and before a call to \fIXmClipboardEndCopy\fP.
.IP "\fBdisplay\fP"
Specifies a pointer to the \fIDisplay\fP structure that was returned in a
previous call to \fIXOpenDisplay\fP or \fIXtDisplay\fP.
.IP "\fBwindow\fP"
Specifies a widget's window ID that
relates the application window to the clipboard.
The widget's window ID can be obtained by using \fIXtWindow\fP.
The same application instance should pass the same window ID to each of the
clipboard functions that it calls.
.IP "\fBitem_id\fP"
Specifies the number assigned to this data item.  This number was returned
by a previous call to \fIXmClipboardStartCopy\fP.
.SH RETURN VALUE
.IP "\fIClipboardSuccess\fP"
The function is successful.
.IP "\fIClipboardLocked\fP"
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.
.IP "\fIClipboardFail\fP"
The function failed because \fIXmClipboardStartCopy\fP was not called or
because the data item contains too many formats.
.SH RELATED INFORMATION
.na
\fIXmClipboardCopy(3X)\fP,
\fIXmClipboardEndCopy(3X)\fP, and \fIXmClipboardStartCopy(3X)\fP.
.ad