1XkbGetIndicatorMap(3) XKB FUNCTIONS XkbGetIndicatorMap(3)
2
3
4
6 XkbGetIndicatorMap - Gets the map for one or more indicators, using a
7 mask to specify the indicators
8
10 Status XkbGetIndicatorMap (Display *dpy, unsigned int which, XkbDescPtr
11 desc);
12
14 - dpy connection to the X server
15
16 - which
17 mask of indicators for which maps should be returned
18
19 - desc keyboard description to be updated
20
22 Xkb allows applications to obtain information about indicators using
23 two different methods. The first method, which is similar to the core X
24 implementation, uses a mask to specify the indicators. The second
25 method, which is more suitable for applications concerned with interop‐
26 erability, uses indicator names. The correspondence between the indica‐
27 tor name and the bit position in masks is as follows: one of the param‐
28 eters returned from XkbGetNamedIndicators is an index that is the bit
29 position to use in any function call that requires a mask of indicator
30 bits, as well as the indicator's index into the XkbIndicatorRec array
31 of indicator maps.
32
33
34 XkbGetIndicatorMap obtains the maps from the server for only those
35 indicators specified by the which mask and copies the values into the
36 keyboard description specified by desc. If the indicators field of the
37 desc parameter is NULL, XkbGetIndicatorMap allocates and initializes
38 it.
39
40 To free the indicator maps, use XkbFreeIndicatorMaps.
41
43 BadAlloc Unable to allocate storage
44
45 BadMatch A compatible version of Xkb was not available in the
46 server or an argument has correct type and range, but is
47 otherwise invalid
48
49 BadImplementation
50 Invalid reply from server
51
53 XkbFreeIndicatorMaps(3), XkbGetNamedIndicators(3)
54
55
56
57
58X Version 11 libX11 1.3.4 XkbGetIndicatorMap(3)