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