1
XGETDEVICEPROPERTY(libmansuffix)
2
================================
7
XGetDeviceProperty, XChangeDeviceProperty,
8
XDeleteDeviceProperty - Get, change or delete a device's
14
#include <X11/extensions/XInput.h>
16
int XGetDeviceProperty( Display *display,
24
Atom *actual_type_return,
25
int *actual_format_return,
26
unsigned long *nitems_return,
27
unsigned long *bytes_after_return,
28
unsigned char **prop_return)
30
void XChangeDeviceProperty( Display *display,
39
void XDeleteDeviceProperty( Display *display,
45
Returns an atom identifier that defines the actual type
49
Returns the actual format of the property.
52
Returns the number of bytes remaining to be read in the
53
property if a partial read was performed.
56
Specifies the property data.
59
Specifies a Boolean value that determines whether the
63
Specifies the connection to the X server.
69
Specifies whether the data should be viewed as a list of
70
8-bit, 16-bit, or 32-bit quantities. Possible values are
71
8, 16, and 32. This information allows the X server to
72
correctly perform byte-swap operations as necessary. If
73
the format is 16-bit or 32-bit, you must explicitly cast
74
the data pointer to an (unsigned char*) in the call to
75
XChangeDeviceProperty.
78
Specifies the length in 32-bit multiplies of the data to
82
Specifies the mode of operation. You can pass
83
PropModeReplace, PropModePrepend, or PropModeAppend.
86
Specifies the number of elements in data.
89
Returns the actual number of 8-bit, 16-bit, or 32-bit
90
items stored in the prop_return array.
93
Specifies the number of elements in the values list.
96
Specifies the offset in the specified property (in
97
32-bit quantities) where the data is to be retrieved.
100
Specifies whether to retrieve the pending state of the
101
property or the current state.
104
Specifies the property to modify or query.
107
Returns the data in the specified format. If the
108
returned format is 8, the returned data is represented
109
as a char array. If the returned format is 16, the
110
returned data is represented as an array of short int
111
type and should be cast to that type to obtain the
112
elements. If the returned format is 32, the property
113
data will be stored as an array of longs (which in a
114
64-bit application will be 64-bit values that are padded
115
in the upper 4 bytes).
118
Specifies the atom identifier associated with the
119
property type or AnyPropertyType.
124
The XGetDeviceProperty function returns the actual type of the
125
property; the actual format of the property; the number of
126
8-bit, 16-bit, or 32-bit items transferred; the number of bytes
127
remaining to be read in the property; and a pointer to the data
128
actually returned. For a detailed description of this function,
129
see the man page to XGetWindowProperty.
131
The XChangeDeviceProperty function alters the property for the
132
specified device and causes the server to generate a
133
XPropertyNotifyEvent event on that device. For a detailed
134
description of this function, see the man page to
137
The XDeleteDeviceProperty function deletes the specified device
138
property. Note that a client cannot delete a property created
139
by a driver or the server. Attempting to do so will result in a
142
XGetDeviceProperty can generate a BadAtom, BadDevice error.
144
XChangeDeviceProperty can generate a BadDevice, a BadMatch, a
145
BadAtom, and a BadValue error.
147
XDeleteDeviceProperty can generate a BadDevice, and a BadAtom
154
A value does not describe a valid named identifier or
155
the client attempted to remove a driver-allocated
159
An invalid device was specified. The device does not
165
XListDeviceProperties(libmansuffix)
added
removed
man/XGetDeviceProperty.txt
