XkbGetIndicatorMap(3)     XKB FUNCTIONS     XkbGetIndicatorMap(3)



NAME
       XkbGetIndicatorMap  - Gets the map for one or more indica-
       tors, using a mask to specify the indicators

SYNOPSIS
       Status XkbGetIndicatorMap ( dpy, which, desc )
             Display *dpy;
             unsigned int which;
             XkbDescPtr desc;

ARGUMENTS
       - dpy  connection to the X server

       - which
              mask  of  indicators  for  which  maps  should   be
              returned

       - desc keyboard description to be updated

DESCRIPTION
       Xkb  allows applications to obtain information about indi-
       cators using two  different  methods.  The  first  method,
       which is similar to the core X implementation, uses a mask
       to specify the indicators. The  second  method,  which  is
       more  suitable  for applications concerned with interoper-
       ability, uses indicator names. The correspondence  between
       the  indicator  name  and  the bit position in masks is as
       follows: one  of  the  parameters  returned  from  XkbGet-
       NamedIndicators  is  an  index that is the bit position to
       use in any function call that requires a mask of indicator
       bits, as well as the indicator's index into the XkbIndica-
       torRec array of indicator maps.


       XkbGetIndicatorMap obtains the maps from  the  server  for
       only  those  indicators  specified  by  the which mask and
       copies the values into the keyboard description  specified
       by desc.  If the indicators field of the desc parameter is
       NULL, XkbGetIndicatorMap allocates and initializes it.

       To free the indicator maps, use XkbFreeIndicatorMaps.

DIAGNOSTICS
       BadAlloc       Unable to allocate storage

       BadMatch       A compatible version of Xkb was not  avail-
                      able  in the server or an argument has cor-
                      rect  type  and  range,  but  is  otherwise
                      invalid

       BadImplementation
                      Invalid reply from server

SEE ALSO
       XkbFreeIndicatorMaps(3), XkbGetNamedIndicators(3)




X Version 11               libX11 1.1.5     XkbGetIndicatorMap(3)