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
18              mask of compatibility map components to fetch
19
20       - xkb  keyboard description where results placed
21

DESCRIPTION

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

DIAGNOSTICS

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