XChangeDeviceProperty(3)

1XGETDEVICEPROPERTY(3)           [FIXME: manual]          XGETDEVICEPROPERTY(3)
2
3
4

NAME

6       XGetDeviceProperty, XChangeDeviceProperty, XDeleteDeviceProperty - Get,
7       change or delete a device´s property.
8

SYNOPSIS

10       #include <X11/extensions/XInput.h>
11
12       int XGetDeviceProperty( Display *display,
13                               XDevice *device,
14                               Atom property,
15                               long offset,
16                               long length,
17                               Bool delete,
18                               Bool pending,
19                               Atom req_type,
20                               Atom *actual_type_return,
21                               int *actual_format_return,
22                               unsigned long *nitems_return,
23                               unsigned long *bytes_after_return,
24                               unsigned char **prop_return)
25
26       void XChangeDeviceProperty( Display *display,
27                                   XDevice *device,
28                                   Atom property,
29                                   Atom type,
30                                   int format,
31                                   int mode,
32                                   const char *data,
33                                   int nelements)
34
35       void XDeleteDeviceProperty( Display *display,
36                                   XDevice *device,
37                                   Atom property)
38
39       actual_type_return
40              Returns an atom identifier that defines the actual type
41              of the property.
42
43       actual_format_return
44              Returns the actual format of the property.
45
46       bytes_after_return
47              Returns the number of bytes remaining to be read in the
48              property if a partial read was performed.
49
50       data
51              Specifies the property data.
52
53       delete
54              Specifies a Boolean value that determines whether the
55              property is deleted.
56
57       display
58              Specifies the connection to the X server.
59
60       device
61              The device to grab.
62
63       format
64              Specifies whether the data should be viewed as a list of
65              8-bit, 16-bit, or 32-bit quantities. Possible values are
66              8, 16, and 32. This information allows the X server to
67              correctly perform byte-swap operations as necessary. If
68              the format is 16-bit or 32-bit, you must explicitly cast
69              the data pointer to an (unsigned char*) in the call to
70              XChangeDeviceProperty.
71
72       length
73              Specifies the length in 32-bit multiplies of the data to
74              be retrieved.
75
76       mode
77              Specifies the mode of operation. You can pass
78              PropModeReplace, PropModePrepend, or PropModeAppend.
79
80       nelements
81              Specifies the number of elements in data.
82
83       nitems_return
84              Returns the actual number of 8-bit, 16-bit, or 32-bit
85              items stored in the prop_return array.
86
87       num_values
88              Specifies the number of elements in the values list.
89
90       offset
91              Specifies the offset in the specified property (in
92              32-bit quantities) where the data is to be retrieved.
93
94       pending
95              Specifies whether to retrieve the pending state of the
96              property or the current state.
97
98       property
99              Specifies the property to modify or query.
100
101       prop_return
102              Returns the data in the specified format. If the
103              returned format is 8, the returned data is represented
104              as a char array. If the returned format is 16, the
105              returned data is represented as an array of short int
106              type and should be cast to that type to obtain the
107              elements. If the returned format is 32, the property
108              data will be stored as an array of longs (which in a
109              64-bit application will be 64-bit values that are padded
110              in the upper 4 bytes).
111
112       req_type
113              Specifies the atom identifier associated with the
114              property type or AnyPropertyType.
115

DESCRIPTION

117       The XGetDeviceProperty function returns the actual type of the
118       property; the actual format of the property; the number of 8-bit,
119       16-bit, or 32-bit items transferred; the number of bytes remaining to
120       be read in the property; and a pointer to the data actually returned.
121       For a detailed description of this function, see the man page to
122       XGetWindowProperty.
123
124       The XChangeDeviceProperty function alters the property for the
125       specified device and causes the server to generate a
126       XPropertyNotifyEvent event on that device. For a detailed description
127       of this function, see the man page to XChangeProperty.
128
129       The XDeleteDeviceProperty function deletes the specified device
130       property. Note that a client cannot delete a property created by a
131       driver or the server. Attempting to do so will result in a BadAtom
132       error.
133
134       XGetDeviceProperty can generate a BadAtom, BadDevice error.
135
136       XChangeDeviceProperty can generate a BadDevice, a BadMatch, a BadAtom,
137       and a BadValue error.
138
139       XDeleteDeviceProperty can generate a BadDevice, and a BadAtom error.
140

DIAGNOSIS

142           BadAtom
143                  A value does not describe a valid named identifier or
144                  the client attempted to remove a driver-allocated
145                  property.
146
147           BadDevice
148                  An invalid device was specified. The device does not
149                  exist.
150

NAME

SYNOPSIS

DESCRIPTION

DIAGNOSIS

SEE ALSO