Manual Pages for UNIX Operating System command usage for man XkbGetIndicatorState

XKB FUNCTIONS                          XkbGetIndicatorState(3x11)



NAME
     XkbGetIndicatorState - Obtains the current state of the key-
     board indicators

SYNOPSIS
     cc [ flag... ] file... -lX11 [ library... ]

     Status XkbGetIndicatorState (Display *display, unsigned  int
          device_spec, unsigned int state_return);

ARGUMENTS
     - display
          connection to the X server

     - device_spec
          device ID, or XkbUseCoreKbd

     - state_return
          backfilled with a mask of the indicator state

DESCRIPTION
     Xkb allows applications to obtain information about  indica-
     tors 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 interoperability, uses indi-
     cator  names.  The correspondence between the indicator name
     and the bit position in masks is  as  follows:  one  of  the
     parameters  returned  from XkbGetNamedIndicators 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 XkbIndicatorRec array of  indica-
     tor maps.

     XkbGetIndicatorState queries the display for  the  state  of
     the  indicators  on the device specified by the device_spec.
     For each indicator that is "turned on" on  the  device,  the
     associated  bit is set in state_return. If a compatible ver-
     sion of the Xkb extension is not available  in  the  server,
     XkbGetIndicatorState returns a BadMatch error. Otherwise, it
     sends the request to the X server, places the state  of  the
     indicators  into state_return, and returns Success. Thus the
     value reported by XkbGetIndicatorState is identical  to  the
     value reported by the core protocol.

DIAGNOSTICS
     BadMatch       A compatible version of Xkb was not available
                    in the server or an argument has correct type
                    and range, but is otherwise invalid

SEE ALSO
     XkbGetNamedIndicators(3x11)



X Version 11        Last change: libX11 1.3.5                   1






XKB FUNCTIONS                          XkbGetIndicatorState(3x11)



ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | x11/library/libx11          |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |_____________________________|_____________________________|










































X Version 11        Last change: libX11 1.3.5                   2