summaryrefslogtreecommitdiff
path: root/man/XIListProperties.txt
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2009-06-02 12:18:58 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2009-06-02 13:25:49 +1000
commitd0be870ee7798deb8cb50cdf350892c9dfc64538 (patch)
treeab449f676b178fd1a603ba5b74a301ee4b38e78f /man/XIListProperties.txt
parent8439d93ef77a934fab171ff9385277f3f2f46213 (diff)
downloadxorg-lib-libXi-d0be870ee7798deb8cb50cdf350892c9dfc64538.tar.gz
Add XI2 property man pages.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'man/XIListProperties.txt')
-rw-r--r--man/XIListProperties.txt54
1 files changed, 54 insertions, 0 deletions
diff --git a/man/XIListProperties.txt b/man/XIListProperties.txt
new file mode 100644
index 0000000..de374cb
--- /dev/null
+++ b/man/XIListProperties.txt
@@ -0,0 +1,54 @@
+XILISTPROPERTIES(libmansuffix)
+=============================
+
+NAME
+----
+
+ XIListProperties - List a device's properties.
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput2.h>
+
+ Atom* XListProperties( Display *display,
+ int deviceid,
+ int *nprops_return);
+
+ display
+ Specifies the connection to the X server.
+
+ deviceid
+ The device to list the properties for.
+
+ nprops_return
+ Specifies the number of Atoms returned.
+
+
+DESCRIPTION
+-----------
+
+The XIListProperties function returns a list of the
+properties associated with the input device specified with
+deviceid. Each device may have an arbitrary number of properties
+attached, some of which were created by the driver and/or
+server, others created by clients at runtime.
+
+The client is expected to free the list of properties using
+XFree.
+
+XIListProperties can generate a BadDevice error.
+
+DIAGNOSTICS
+-----------
+
+BadDevice
+ An invalid device was specified. The device does not
+ exist.
+
+SEE ALSO
+--------
+
+XIChangeProperty(libmansuffix),
+XIGetProperty(libmansuffix),
+XIDeleteProperty(libmansuffix)