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

NAME

6       XkbGetIndicatorMap  -  Gets the map for one or more indicators, using a
7       mask to specify the indicators
8

SYNOPSIS

10       Status XkbGetIndicatorMap (Display *dpy, unsigned int which, XkbDescPtr
11              desc);
12

ARGUMENTS

14       dpy    connection to the X server
15
16       which  mask of indicators for which maps should be returned
17
18       desc   keyboard description to be updated
19

DESCRIPTION

21       Xkb  allows  applications  to obtain information about indicators using
22       two different methods. The first method, which is similar to the core X
23       implementation,  uses  a  mask  to  specify  the indicators. The second
24       method, which is more suitable for applications concerned with interop‐
25       erability, uses indicator names. The correspondence between the indica‐
26       tor name and the bit position in masks is as follows: one of the param‐
27       eters  returned  from XkbGetNamedIndicators is an index that is the bit
28       position to use in any function call that requires a mask of  indicator
29       bits,  as  well as the indicator's index into the XkbIndicatorRec array
30       of indicator maps.
31
32
33       XkbGetIndicatorMap obtains the maps from the server for only those  in‐
34       dicators  specified  by  the  which mask and copies the values into the
35       keyboard description specified by desc.  If the indicators field of the
36       desc  parameter  is  NULL, XkbGetIndicatorMap allocates and initializes
37       it.
38
39       To free the indicator maps, use XkbFreeIndicatorMaps.
40

DIAGNOSTICS

42       BadAlloc       Unable to allocate storage
43
44       BadMatch       A compatible version of Xkb was  not  available  in  the
45                      server or an argument has correct type and range, but is
46                      otherwise invalid
47
48       BadImplementation
49                      Invalid reply from server
50

SEE ALSO

52       XkbFreeIndicatorMaps(3), XkbGetNamedIndicators(3)
53
54
55
56
57X Version 11                     libX11 1.8.7            XkbGetIndicatorMap(3)
Impressum