~ubuntu-branches/ubuntu/natty/libxi/natty-201011191114

« back to all changes in this revision

Viewing changes to man/XIListProperties.txt

  • Committer: Bazaar Package Importer
  • Author(s): Julien Cristau
  • Date: 2009-11-21 18:39:28 UTC
  • mfrom: (1.1.10 upstream) (0.1.6 experimental)
  • Revision ID: james.westby@ubuntu.com-20091121183928-ek2jwqx3rmhv3zjz
Tags: 2:1.3-1
* Bump Standards-Version to 3.8.3.
* Add build-deps on xmlto and asciidoc to build the manpages.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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)