man/XListDeviceProperties.man

   1 '\" t
   2 .\"     Title: xlistdeviceproperties
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 09/23/2011
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "XLISTDEVICEPROPERTIE" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 XListDeviceProperties \- List a device\*(Aqs properties\&.
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 #include <X11/extensions/XInput\&.h>
  36 .fi
  37 .sp
  38 .nf
  39 Atom* XListDeviceProperties( Display *display,
  40                              XDevice *device,
  41                              int *nprops_return);
  42 .fi
  43 .sp
  44 .nf
  45 display
  46        Specifies the connection to the X server\&.
  47 .fi
  48 .sp
  49 .nf
  50 device
  51        The device to list the properties for\&.
  52 .fi
  53 .sp
  54 .nf
  55 nprops_return
  56        Specifies the number of Atoms returned\&.
  57 .fi
  58 .SH "DESCRIPTION"
  59 .sp
  60 .if n \{\
  61 .RS 4
  62 .\}
  63 .nf
  64 The XListDeviceProperties function returns a list of the
  65 properties associated with the input device specified in
  66 device\&. Each device may have an arbitrary number of properties
  67 attached, some of which were created by the driver and/or
  68 server, others created by clients at runtime\&.
  69 .fi
  70 .if n \{\
  71 .RE
  72 .\}
  73 .sp
  74 .if n \{\
  75 .RS 4
  76 .\}
  77 .nf
  78 The client is expected to free the list of properties using
  79 XFree\&.
  80 .fi
  81 .if n \{\
  82 .RE
  83 .\}
  84 .sp
  85 .if n \{\
  86 .RS 4
  87 .\}
  88 .nf
  89 XListDeviceProperties can generate a BadDevice error\&.
  90 .fi
  91 .if n \{\
  92 .RE
  93 .\}
  94 .SH "DIAGNOSTICS"
  95 .sp
  96 .if n \{\
  97 .RS 4
  98 .\}
  99 .nf
 100 BadDevice
 101        An invalid device was specified\&. The device does not
 102        exist\&.
 103 .fi
 104 .if n \{\
 105 .RE
 106 .\}
 107 .SH "SEE ALSO"
 108 .sp
 109 .if n \{\
 110 .RS 4
 111 .\}
 112 .nf
 113 XChangeDeviceProperty(libmansuffix),
 114 XGetDeviceProperty(libmansuffix),
 115 XDeleteDeviceProperty(libmansuffix)
 116 .fi
 117 .if n \{\
 118 .RE
 119 .\}