1XmClipboardRegisterFormat(library call)XmClipboardRegisterFormat(library call)
2
3
4
6 XmClipboardRegisterFormat — A clipboard function that registers a new
7 format
8
10 #include <Xm/CutPaste.h>
11 int XmClipboardRegisterFormat (display, format_name, format_length)
12 Display * display;
13 char * format_name;
14 int format_length;
15 (void)
16
18 XmClipboardRegisterFormat registers a new format. Each format stored on
19 the clipboard should have a length associated with it; this length must
20 be known to the clipboard routines. Formats are known as targets in the
21 Inter-Client Communication Conventions Manual (ICCCM). All of the for‐
22 mats specified by version 1.1 of the ICCCM conventions are preregis‐
23 tered. Any other format that the application wants to use must either
24 be 8-bit data or be registered via this routine. Failure to register
25 the length of the data results in incompatible applications across
26 platforms having different byte-swapping orders.
27
28 display Specifies a pointer to the Display structure that was
29 returned in a previous call to XOpenDisplay or XtDisplay.
30
31 format_name
32 Specifies the string name for the new format (target).
33
34 format_length
35 Specifies the format length in bits (8, 16, or 32).
36
38 XmClipboardBadFormat
39 The format_name must not be NULL, and the format_length must
40 be 8, 16, or 32.
41
42 XmClipboardSuccess
43 The function was successful.
44
45 XmClipboardLocked
46 The function failed because the clipboard was locked by
47 another application. The application can continue to call the
48 function again with the same parameters until the lock goes
49 away. This gives the application the opportunity to ask if
50 the user wants to keep trying or to give up on the operation.
51
52 XmClipboardFail
53 The function failed because the specified format was already
54 registered with a different length from that specified now.
55 If a specified format was already registered with the same
56 length as that specified now, XmClipboardSuccess is returned.
57
59 XmClipboardStartCopy(3).
60
61
62
63 XmClipboardRegisterFormat(library call)