1XkbQueryExtension(3)             XKB FUNCTIONS            XkbQueryExtension(3)
2
3
4

NAME

6       XkbQueryExtension  -  Determines the compatibility of a library at run‐
7       time.
8

SYNOPSIS

10       Bool   XkbQueryExtension   (Display   *dpy,   int   *opcode_rtrn,   int
11              *event_rtrn,   int  *error_rtrn,  int  *major_in_out,  int  *mi‐
12              nor_in_out);
13

ARGUMENTS

15       dpy    connection to the X server
16
17       opcode_rtrn
18              backfilled with the major extension opcode
19
20       event_rtrn
21              backfilled with the extension base event code
22
23       error_rtrn
24              backfilled with the extension base error code
25
26       major_in_out
27              compile time lib major version in, server major version out
28
29       minor_in_out
30              compile time lib min version in, server minor version out
31

DESCRIPTION

33       Call XkbQueryExtension to check for the presence and  compatibility  of
34       the extension in the server and to initialize the extension. Because of
35       potential version mismatches, you  cannot  use  the  generic  extension
36       mechanism functions ( XQueryExtension and XInitExtension ) for checking
37       for the presence of, and initializing the Xkb extension.
38
39       You must call XkbQueryExtension  or  XkbOpenDisplay  before  using  any
40       other  Xkb  library interfaces, unless such usage is explicitly allowed
41       in the interface description in this document. The exceptions are:  Xk‐
42       bIgnoreExtension,  XkbLibraryVersion,  and  a  handful  of audible-bell
43       functions. You should not use any other Xkb functions if the  extension
44       is  not  present  or is uninitialized. In general, calls to Xkb library
45       functions made prior to initializing the Xkb extension cause  BadAccess
46       protocol errors.
47
48       XkbQueryExtension both determines whether a compatible Xkb extension is
49       present in the X server  and  initializes  the  extension  when  it  is
50       present.
51
52       The  XkbQueryExtension function determines whether a compatible version
53       of the X Keyboard Extension is present in the server. If  a  compatible
54       extension is present, XkbQueryExtension returns True; otherwise, it re‐
55       turns False.
56
57       If a compatible version of Xkb is present,  XkbQueryExtension  initial‐
58       izes  the extension. It backfills the major opcode for the keyboard ex‐
59       tension in opcode_rtrn, the base event code in event_rtrn, the base er‐
60       ror  code in error_rtrn, and the major and minor version numbers of the
61       extension in major_in_out and minor_in_out.  The major  opcode  is  re‐
62       ported  in the req_major fields of some Xkb events. For a discussion of
63       the base event code.
64

RETURN VALUES

66       True           The XkbQueryExtension function returns True if it deter‐
67                      mines  a  compatible version of the X Keyboard Extension
68                      is present in the server.
69
70       False          The XkbQueryExtension function returns False if  it  de‐
71                      termines  a  compatible version of the X Keyboard Exten‐
72                      sion is not present in the server.
73

SEE ALSO

75       XkbIgnoreExtension(3), XkbLibraryVersion(3), XkbOpenDisplay(3)
76
77
78
79X Version 11                     libX11 1.7.2             XkbQueryExtension(3)
Impressum