'\" t

...\" ClipbC.sgm /main/10 1996/09/25 10:23:50 cdedoc $

.de P!

.fl

\!!1 setgray

.fl

\\&.\"

.fl

\!!0 setgray

.fl			\" force out current output buffer

\!!save /psv exch def currentpoint translate 0 0 moveto

\!!/showpage{}def

.fl			\" prolog

.sy sed -e 's/^/!/' \\$1\" bring in postscript file

\!!psv restore

.

.de pF

.ie     ?\\*(f1?? .ds f1 \\n(.f

.el .ie ?\\*(f2?? .ds f2 \\n(.f

.el .ie ?\\*(f3?? .ds f3 \\n(.f

.el .ie ?\\*(f4?? .ds f4 \\n(.f

.el .tm ? font overflow

.ft \\$1

..

.de fP

.ie     !?\\*(f4?? \{\

.	ft \\*(f4

.	ds f4\"

'	br \}

.el .ie !?\\*(f3?? \{\

.	ft \\*(f3

.	ds f3\"

'	br \}

.el .ie !?\\*(f2?? \{\

.	ft \\*(f2

.	ds f2\"

'	br \}

.el .ie !?\\*(f1?? \{\

.	ft \\*(f1

.	ds f1\"

'	br \}

.el .tm ? font underflow

..

.ds f1\"

.ds f2\"

.ds f3\"

.ds f4\"

.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 

.TH "XmClipboardCopyByName" "library call"

.SH "NAME"

\fBXmClipboardCopyByName\fP \(em A clipboard function that copies a data item passed by name

.iX "XmClipboardCopyByName"

.iX "clipboard functions" "XmClipboardCopyByName"

.SH "SYNOPSIS"

.PP

.nf

#include <Xm/CutPaste\&.h>

int XmClipboardCopyByName (\fIdisplay, window, data_id,

        buffer, length, private_id\fP)

        Display \fI* display\fP;

        Window  \fIwindow\fP;

        long    \fIdata_id\fP;

        XtPointer       \fIbuffer\fP;

        unsigned long   \fIlength\fP;

        long    \fIprivate_id\fP;

\fB\fR(\fBvoid\fR)

.fi

.SH "DESCRIPTION"

.PP

\fBXmClipboardCopyByName\fP copies the actual data for a data item

that was previously passed by name to the clipboard\&. Data is

considered to be passed by name when a call to \fBXmClipboardCopy\fP

is made with a NULL buffer parameter\&. Additional calls to this

function append new data to the existing data\&.

.IP "\fIdisplay\fP" 10

Specifies a pointer to the \fBDisplay\fR structure that was returned in a

previous call to \fBXOpenDisplay\fP or \fBXtDisplay\fP\&.

.IP "\fIwindow\fP" 10

Specifies the window ID of a widget that relates the application window to the

clipboard\&. The widget\&'s window ID can be obtained through

\fBXtWindow\fP\&.

The same application instance should pass the same window ID to each

clipboard function it calls\&.

.IP "\fIdata_id\fP" 10

Specifies an identifying number assigned to the data item that uniquely

identifies the data item and the format\&. This number was assigned by

\fBXmClipboardCopy\fP to the data item\&.

.IP "\fIbuffer\fP" 10

Specifies the buffer from which the clipboard copies the data\&.

.IP "\fIlength\fP" 10

Specifies the number of bytes in the data item\&.

.IP "\fIprivate_id\fP" 10

Specifies the private data that the application wants to store with the

data item\&.

.SH "RETURN"

.IP "\fBXmClipboardSuccess\fP" 10

The function was successful\&.

.IP "\fBXmClipboardLocked\fP" 10

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\&.

.SH "RELATED"

.PP

\fBXmClipboardCopy\fP(3), \fBXmClipboardLock\fP(3),

\fBXmClipboardStartCopy\fP(3), and \fBXmClipboardUnlock\fP(3)\&.

...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:18