2 .\" Title: xgetdeviceproperty
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: [FIXME: manual]
7 .\" Source: [FIXME: source]
10 .TH "XGETDEVICEPROPERTY" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 XGetDeviceProperty, XChangeDeviceProperty, XDeleteDeviceProperty \- Get, change or delete a device\*(Aqs property\&.
35 #include <X11/extensions/XInput\&.h>
39 int XGetDeviceProperty( Display *display,
46 Atom *actual_type_return,
47 int *actual_format_return,
48 unsigned long *nitems_return,
49 unsigned long *bytes_after_return,
50 unsigned char **prop_return)
54 void XChangeDeviceProperty( Display *display,
65 void XDeleteDeviceProperty( Display *display,
72 Returns an atom identifier that defines the actual type
78 Returns the actual format of the property\&.
83 Returns the number of bytes remaining to be read in the
84 property if a partial read was performed\&.
89 Specifies the property data\&.
94 Specifies a Boolean value that determines whether the
95 property is deleted\&.
100 Specifies the connection to the X server\&.
105 The device to grab\&.
110 Specifies whether the data should be viewed as a list of
111 8\-bit, 16\-bit, or 32\-bit quantities\&. Possible values are
112 8, 16, and 32\&. This information allows the X server to
113 correctly perform byte\-swap operations as necessary\&. If
114 the format is 16\-bit or 32\-bit, you must explicitly cast
115 the data pointer to an (unsigned char*) in the call to
116 XChangeDeviceProperty\&.
121 Specifies the length in 32\-bit multiplies of the data to
127 Specifies the mode of operation\&. You can pass
128 PropModeReplace, PropModePrepend, or PropModeAppend\&.
133 Specifies the number of elements in data\&.
138 Returns the actual number of 8\-bit, 16\-bit, or 32\-bit
139 items stored in the prop_return array\&.
144 Specifies the number of elements in the values list\&.
149 Specifies the offset in the specified property (in
150 32\-bit quantities) where the data is to be retrieved\&.
155 Specifies the property to modify or query\&.
160 Returns the data in the specified format\&. If the
161 returned format is 8, the returned data is represented
162 as a char array\&. If the returned format is 16, the
163 returned data is represented as an array of short int
164 type and should be cast to that type to obtain the
165 elements\&. If the returned format is 32, the property
166 data will be stored as an array of longs (which in a
167 64\-bit application will be 64\-bit values that are padded
168 in the upper 4 bytes)\&.
173 Specifies the atom identifier associated with the
174 property type or AnyPropertyType\&.
178 The XGetDeviceProperty function returns the actual type of the property; the actual format of the property; the number of 8\-bit, 16\-bit, or 32\-bit items transferred; the number of bytes remaining to be read in the property; and a pointer to the data actually returned\&. For a detailed description of this function, see the man page to XGetWindowProperty\&.
180 The XChangeDeviceProperty function alters the property for the specified device and causes the server to generate a XPropertyNotifyEvent event on that device\&. For a detailed description of this function, see the man page to XChangeProperty\&.
182 The XDeleteDeviceProperty function deletes the specified device property\&. Note that a client cannot delete a property created by a driver or the server\&. Attempting to do so will result in a BadAtom error\&.
184 XGetDeviceProperty can generate a BadAtom, BadDevice error\&.
186 XChangeDeviceProperty can generate a BadDevice, a BadMatch, a BadAtom, and a BadValue error\&.
188 XDeleteDeviceProperty can generate a BadDevice, and a BadAtom error\&.
196 A value does not describe a valid named identifier or
197 the client attempted to remove a driver\-allocated
209 An invalid device was specified\&. The device does not
221 XListDeviceProperties(libmansuffix)