XkbGetNamedIndicator(3) XKB FUNCTIONS XkbGetNamedIndicator(3)

# [NAME](#NAME)

XkbGetNamedIndicator - Look up the indicator map and other information for an indicator by name

# [SYNOPSIS](#SYNOPSIS)

**Bool XkbGetNamedDeviceIndicator** **(Display \*dpy,** **unsigned int dev\_spec,** **unsigned int led\_class,** **unsigned int led\_id,** **Atom name,** **int \*ndx\_rtrn,** **Bool \*state\_rtrn,** **XkbIndicatorMapPtr map\_rtrn,** **Bool \*real\_rtrn);**

**Bool XkbGetNamedIndicator** **(Display \*dpy,** **Atom name,** **int \*ndx\_rtrn,** **Bool \*state\_rtrn,** **XkbIndicatorMapPtr map\_rtrn,** **Bool \*real\_rtrn);**

# [ARGUMENTS](#ARGUMENTS)

[*dpy*](#dpy)

connection to the X server

[*dev\_spec*](#dev_spec)

keyboard device ID, or XkbUseCoreKbd

[*led\_class*](#led_class)

feedback class, or XkbDfltXIClass

[*led\_id*](#led_id)

feedback ID, or XkbDfltXIId

[*name*](#name)

name of the indicator to be retrieved

[*ndx\_rtrn*](#ndx_rtrn)

backfilled with the index of the retrieved indicator

[*state\_rtrn*](#state_rtrn)

backfilled with the current state of the retrieved indicator

[*map\_rtrn*](#map_rtrn)

backfilled with the mapping for the retrieved indicator

[*real\_rtrn*](#real_rtrn)

backfilled with True if the named indicator is real (physical)

# [DESCRIPTION](#DESCRIPTION)

Xkb also allows applications to refer to indicators by name. Use *XkbGetNames* to get the indicator names. Using names eliminates the need for hard-coding bitmask values for particular keyboards. For example, instead of using vendor-specific constants such as WSKBLed\_ScrollLock mask on Digital workstations or XLED\_SCROLL\_LOCK on Sun workstations, you can instead use *XkbGetNamedDeviceIndicator* to look up information on the indicator named "Scroll Lock."

If the device specified by *device\_spec* has an indicator named *name*, *XkbGetNamedDeviceIndicator* returns True and populates the rest of the parameters with information about the indicator. Otherwise, *XkbGetNamedDeviceIndicator* returns False.

The *ndx\_rtrn* field returns the zero-based index of the named indicator. This index 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 indicator maps. *state\_rtrn* returns the current state of the named indicator (True = on, False = off). *map\_rtrn* returns the indicator map for the named indicator. In addition, if the indicator is mapped to a physical LED, the *real\_rtrn* parameter is set to True.

Each of the " *\_rtrn* " arguments is optional; you can pass NULL for any unneeded " *\_rtrn* " arguments.

*XkbGetNamedIndicator* is a convenience function that calls *XkbGetNamedDeviceIndicator* with a *device\_spec* of **XkbUseCoreKbd**, a *led\_class* of **XkbDfltXIClass**, and a *led\_id* of **XkbDfltXIId**. It returns the return value from *XkbGetNamedDeviceIndicator*.

# [RETURN VALUES](#RETURN_VALUES)

[True](#True)

The *XkbGetNamedIndicator* and *XkbGetNamedDeviceIndicator* functions return True if the device specified by *device\_spec* has an indicator named *name*.

[False](#False)

The *XkbGetNamedIndicator* and *XkbGetNamedDeviceIndicator* functions return False if the device specified by *device\_spec* does not have an indicator named *name*.

# [SEE ALSO](#SEE_ALSO)

[**XkbGetNames**(3)](/man/os/libx11/XkbGetNames.3)

libX11 1.8.14 X Version 11

---

Document: XkbGetNamedIndicator(3) from libx11 1.8.14-r0 (Chainguard OS)
Source: https://gitlab.freedesktop.org/xorg/lib/libx11.git