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

DESCRIPTION

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

DIAGNOSIS

137           BadAtom
138                  A value does not describe a valid named identifier or
139                  the client attempted to remove a driver-allocated
140                  property.
141
142           BadDevice
143                  An invalid device was specified. The device does not
144                  exist.
145

SEE ALSO

147           XListDeviceProperties(3)
148
149
150
151                                  05/04/2023             XGETDEVICEPROPERTY(3)
Impressum