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

NAME

6       XkbGetCompatMap  -  Fetch  any combination of the current compatibility
7       map components from the server
8

SYNOPSIS

10       Status XkbGetCompatMap (Display *display, unsigned  int  which,  XkbDe‐
11              scRec *xkb);
12

ARGUMENTS

14       display
15              connection to server
16
17       which  mask of compatibility map components to fetch
18
19       xkb    keyboard description where results placed
20

DESCRIPTION

22       When another client modifies the compatibility map, you are notified if
23       you have selected for XkbCompatMapNotify  events.   XkbGetCompatMap  is
24       particularly  useful  when you receive an event of this type, as it al‐
25       lows you to update your program's version of the compatibility  map  to
26       match  the modified version now in the server. If your program is deal‐
27       ing with multiple servers and needs to configure them all in a  similar
28       manner,  the updated compatibility map may be used to reconfigure other
29       servers.
30
31       XkbGetCompatMap fetches the components of the compatibility map  speci‐
32       fied  in  which from the server specified by display and places them in
33       the compat structure of the keyboard description xkb.  Valid values for
34       which are an inclusive OR of the values shown in Table 1.
35
36
37                 Table 1 Compatibility Map Component Masks
38       ───────────────────────────────────────────────────────────────
39       Mask                 Value    Affecting
40       ───────────────────────────────────────────────────────────────
41       XkbSymInterpMask     (1<<0)   Symbol interpretations
42       XkbGroupCompatMask   (1<<1)   Group maps
43       XkbAllCompatMask     (0x3)    All compatibility map components
44
45       If  no  compatibility map structure is allocated in xkb upon entry, Xk‐
46       bGetCompatMap allocates one. If one already exists,  its  contents  are
47       overwritten with the returned results.
48
49       XkbGetCompatMap  fetches  compatibility  map information for the device
50       specified by the device_spec field of xkb.  Unless  you  have  specifi‐
51       cally  modified this field, it is the default keyboard device.  XkbGet‐
52       CompatMap returns Success if successful, BadAlloc if it  is  unable  to
53       obtain  necessary  storage  for either the return values or work space,
54       BadMatch if the dpy field of the xkb argument is non-NULL and does  not
55       match  the  display  argument,  and  BadLength under certain conditions
56       caused by server or Xkb implementation errors.
57

DIAGNOSTICS

59       BadAlloc       Unable to allocate storage
60
61       BadLength      The length of a request is shorter or longer  than  that
62                      required to minimally contain the arguments
63
64       BadMatch       A  compatible  version  of  Xkb was not available in the
65                      server or an argument has correct type and range, but is
66                      otherwise invalid
67
68
69
70X Version 11                     libX11 1.8.7               XkbGetCompatMap(3)
Impressum