---
name: "XkbGetNamedIndicator"
section: "3"
platform: "linux"
package: "libx11"
version: "1.8.14-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/XkbGetNamedIndicator"
---

# XkbGetNamedIndicator(3)

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

## NAME

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

## 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

- *dpy*

  connection to the X server

- *dev\_spec*

  keyboard device ID, or XkbUseCoreKbd

- *led\_class*

  feedback class, or XkbDfltXIClass

- *led\_id*

  feedback ID, or XkbDfltXIId

- *name*

  name of the indicator to be retrieved

- *ndx\_rtrn*

  backfilled with the index of the retrieved indicator

- *state\_rtrn*

  backfilled with the current state of the retrieved indicator

- *map\_rtrn*

  backfilled with the mapping for the retrieved indicator

- *real\_rtrn*

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

## 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

- True

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

- False

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

## SEE ALSO

[**XkbGetNames**(3)](/XkbGetNames/3.md)