1XmClipboardCopyByName(library call)        XmClipboardCopyByName(library call)
2
3
4

NAME

6       XmClipboardCopyByName  —  A  clipboard function that copies a data item
7       passed by name
8

SYNOPSIS

10       #include <Xm/CutPaste.h>
11       int XmClipboardCopyByName (display, window, data_id,
12               buffer, length, private_id)
13               Display * display;
14               Window  window;
15               long    data_id;
16               XtPointer       buffer;
17               unsigned long   length;
18               long    private_id;
19       (void)
20

DESCRIPTION

22       XmClipboardCopyByName copies the actual data for a data item  that  was
23       previously  passed  by  name to the clipboard. Data is considered to be
24       passed by name when a call to XmClipboardCopy is made with a NULL  buf‐
25       fer parameter. Additional calls to this function append new data to the
26       existing data.
27
28       display   Specifies  a  pointer  to  the  Display  structure  that  was
29                 returned in a previous call to XOpenDisplay or XtDisplay.
30
31       window    Specifies the window ID of a widget that relates the applica‐
32                 tion window to the clipboard. The widget's window ID  can  be
33                 obtained  through  XtWindow.   The  same application instance
34                 should pass the same window ID to each clipboard function  it
35                 calls.
36
37       data_id   Specifies  an  identifying  number  assigned to the data item
38                 that uniquely identifies the data item and the  format.  This
39                 number was assigned by XmClipboardCopy to the data item.
40
41       buffer    Specifies  the  buffer  from  which  the clipboard copies the
42                 data.
43
44       length    Specifies the number of bytes in the data item.
45
46       private_id
47                 Specifies the private data  that  the  application  wants  to
48                 store with the data item.
49

RETURN

51       XmClipboardSuccess
52                 The function was successful.
53
54       XmClipboardLocked
55                 The  function  failed  because  the  clipboard  was locked by
56                 another application. The application can continue to call the
57                 function  again  with the same parameters until the lock goes
58                 away. This gives the application the opportunity  to  ask  if
59                 the user wants to keep trying or to give up on the operation.
60
62       XmClipboardCopy(3),  XmClipboardLock(3),  XmClipboardStartCopy(3),  and
63       XmClipboardUnlock(3).
64
65
66
67                                           XmClipboardCopyByName(library call)
Impressum