Merge branch 'master' of ssh://tz.otcshare.org/profile/base/libXi
[platform/upstream/libXi.git] / man / XGetExtensionVersion.man
1 '\" t
2 .\"     Title: xgetextensionversion
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 "XGETEXTENSIONVERSION" "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 XGetExtensionVersion \- query the version of the input extension\&.
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 #include <X11/extensions/XInput\&.h>
36 .fi
37 .sp
38 .nf
39 XExtensionVersion *XGetExtensionVersion( Display *display,
40                                          char *name);
41 .fi
42 .sp
43 .nf
44 display
45        Specifies the connection to the X server\&.
46 .fi
47 .sp
48 .nf
49 name
50        Specifies the extension to be queried\&. The input
51        extension name is definedin the header file XI\&.h\&.
52 .fi
53 .SH "DESCRIPTION"
54 .sp
55 .if n \{\
56 .RS 4
57 .\}
58 .nf
59 The XGetExtensionVersion request is deprecated and should not
60 be used in XI2 applications\&. Clients issuing a XGetExtensionVersion
61 request will not be able to use XI2 features\&.
62 .fi
63 .if n \{\
64 .RE
65 .\}
66 .sp
67 .if n \{\
68 .RS 4
69 .\}
70 .nf
71 The XGetExtensionVersion request queries the version of the input
72 extension, and returns an XExtensionVersion structure\&. This structure
73 contains a major_version and minor_version number which can be compared
74 with constants defined in XI\&.h\&. Support for additional protocol
75 requests added to the input extension after its initial release
76 is indicated by a version number corresponding to the added
77 requests\&. Each version contains all the protocol requests
78 contained by previous versions\&.
79 .fi
80 .if n \{\
81 .RE
82 .\}
83 .sp
84 .if n \{\
85 .RS 4
86 .\}
87 .nf
88 You should use XFree to free the XExtensionVersion structure\&.
89 .fi
90 .if n \{\
91 .RE
92 .\}
93 .SH "STRUCTURES"
94 .sp
95 .if n \{\
96 .RS 4
97 .\}
98 .nf
99 This request returns an XExtensionVersion structure\&.
100 .fi
101 .if n \{\
102 .RE
103 .\}
104 .sp
105 .if n \{\
106 .RS 4
107 .\}
108 .nf
109 typedef struct {
110     int present;
111     short major_version;
112     short minor_version;
113 } XExtensionVersion;
114 .fi
115 .if n \{\
116 .RE
117 .\}