package version up
[platform/upstream/libXi.git] / man / XListDeviceProperties.txt
1 XLISTDEVICEPROPERTIES(libmansuffix)
2 ===================================
3
4 NAME
5 ----
6
7    XListDeviceProperties - List a device's properties.
8
9 SYNOPSIS
10 --------
11
12    #include <X11/extensions/XInput.h>
13
14    Atom* XListDeviceProperties( Display *display,
15                                 XDevice *device,
16                                 int *nprops_return);
17
18    display
19           Specifies the connection to the X server.
20
21    device
22           The device to list the properties for.
23
24    nprops_return
25           Specifies the number of Atoms returned.
26
27 DESCRIPTION
28 -----------
29
30    The XListDeviceProperties function returns a list of the
31    properties associated with the input device specified in
32    device. Each device may have an arbitrary number of properties
33    attached, some of which were created by the driver and/or
34    server, others created by clients at runtime.
35
36    The client is expected to free the list of properties using
37    XFree.
38
39    XListDeviceProperties can generate a BadDevice error.
40
41 DIAGNOSTICS
42 -----------
43
44    BadDevice
45           An invalid device was specified. The device does not
46           exist.
47
48 SEE ALSO
49 --------
50
51    XChangeDeviceProperty(libmansuffix),
52    XGetDeviceProperty(libmansuffix),
53    XDeleteDeviceProperty(libmansuffix)