man/XIQueryVersion.man

   1 '\" t
   2 .\"     Title: xiqueryversion
   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: 04/23/2012
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "XIQUERYVERSION" "libmansuffix" "04/23/2012" "[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 XIQueryVersion \- announce and query the support XI2 version\&.
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 #include <X11/extensions/XInput2\&.h>
  36 .fi
  37 .sp
  38 .nf
  39 Status XIQueryVersion( Display *display,
  40                        int *major_version_inout,
  41                        int *minor_version_inout);
  42 .fi
  43 .sp
  44 .nf
  45 display
  46        Specifies the connection to the X server\&.
  47 .fi
  48 .sp
  49 .nf
  50 major_version_inout
  51        Specifies the client\*(Aqs supported XI2 version, and
  52        returns the server\*(Aqs supported version\&.
  53 .fi
  54 .sp
  55 .nf
  56 minor_version_inout
  57        Specifies the client\*(Aqs supported XI2 version, and
  58        returns the server\*(Aqs supported version\&.
  59 .fi
  60 .SH "DESCRIPTION"
  61 .sp
  62 .if n \{\
  63 .RS 4
  64 .\}
  65 .nf
  66 XIQueryVersion announces the client\*(Aqs supported XI2 version to
  67 the server and returns server\*(Aqs supported X Input version\&. Clients
  68 are required to use XIQueryVersion instead of XGetExtensionVersion
  69 if they use XI2 calls\&. The server may treat a client differently
  70 depending on the supported version announced by the client\&.
  71 The major_version_inout must be 2 or greater, otherwise a BadValue
  72 error occurs\&.
  73 .fi
  74 .if n \{\
  75 .RE
  76 .\}
  77 .sp
  78 .if n \{\
  79 .RS 4
  80 .\}
  81 .nf
  82 If the server does not support XI2, XIQueryVersion returns BadRequest
  83 to the client\&. Otherwise, XIQueryVersion returns Success\&. In both
  84 cases major_version_inout and minor_version_inout are set to the
  85 server\*(Aqs supported version\&.
  86 .fi
  87 .if n \{\
  88 .RE
  89 .\}
  90 .sp
  91 .if n \{\
  92 .RS 4
  93 .\}
  94 .nf
  95 Consecutive calls to XIQueryVersion by the same client always return the
  96 first returned major\&.minor version\&. If the client requests a version
  97 lower than the first returned major\&.minor version in a subsequent call, a
  98 BadValue error occurs\&.
  99 .fi
 100 .if n \{\
 101 .RE
 102 .\}
 103 .sp
 104 .if n \{\
 105 .RS 4
 106 .\}
 107 .nf
 108 XIQueryVersion can generate a BadValue error\&.
 109 .fi
 110 .if n \{\
 111 .RE
 112 .\}
 113 .SH "EXAMPLES"
 114 .sp
 115 .if n \{\
 116 .RS 4
 117 .\}
 118 .nf
 119 int rc;
 120 int major = 2;
 121 int minor = 0;
 122 .fi
 123 .if n \{\
 124 .RE
 125 .\}
 126 .sp
 127 .if n \{\
 128 .RS 4
 129 .\}
 130 .nf
 131 rc = XIQueryVersion(dpy, &major, &minor);
 132 if (rc == Success)
 133     printf("XI2 supported\&. (%d\&.%d)\en", major, minor);
 134 else if (rc == BadRequest)
 135     printf("No XI2 support\&. (%d\&.%d only)\en", major, minor);
 136 else
 137     printf("Internal error\en");
 138 .fi
 139 .if n \{\
 140 .RE
 141 .\}
 142 .SH "DIAGNOSTICS"
 143 .sp
 144 .if n \{\
 145 .RS 4
 146 .\}
 147 .nf
 148 BadValue
 149        A value is outside of the permitted range\&.
 150 .fi
 151 .if n \{\
 152 .RE
 153 .\}