XmClipboardCopy

A clipboard function that copies a data item to temporary storage for later copying to clipboard

Format

#include <Xm/CutPaste.h>
int XmClipboardCopy ( display, window, item_id, format_name,
        buffer, length, private_id, data_id)
        Display  * display;
        Window   window;
        long     item_id;
        char     * format_name;
        XtPointer        buffer;
        unsigned long    length;
        long     private_id;
        long     * data_id;
(VOID)

DESCRIPTION

XmClipboardCopy copies a data item to temporary storage. The data item is moved from temporary storage to the clipboard data structure when a call to XmClipboardEndCopy is made. Additional calls to XmClipboardCopy before a call to XmClipboardEndCopy add additional data item formats to the same data item or append data to an existing format. Formats are described in the Inter-Client Communication Conventions Manual (ICCCM) as targets.

NOTE: Do not call XmClipboardCopy before a call to XmClipboardStartCopy has been made. The latter function allocates temporary storage required by XmClipboardCopy.

If the buffer argument is NULL, the data is considered to be passed by name. When data that has been passed by name is later requested by another application, the application that owns the data receives a callback with a request for the data. The application that owns the data must then transfer the data to the clipboard with the XmClipboardCopyByName function. When a data item that was passed by name is deleted from the clipboard, the application that owns the data receives a callback stating that the data is no longer needed.

For information on the callback function, see the callback argument description for XmClipboardStartCopy.