carta
XkbLatchGroup(3)

XkbLatchGroup3

Latches the keysym group

Usage

Bool XkbLatchGroup (Display *display, unsigned int device_spec, unsigned int group);

Arguments

display

connection to the X server

device_spec

device ID, or XkbUseCoreKbd

group

index of the keysym group to latch

Overview

XkbLatchGroup sends a request to the server to latch the specified group and does not wait for a reply. It returns True if the request was sent and False otherwise.

Reference the keysym group indices with these symbolic constants:

Table 1 Symbolic Group Names
Symbolic NameValue
XkbGroup1Index0
XkbGroup2Index1
XkbGroup3Index2
XkbGroup4Index3

Return values

True

The XkbLatchGroup function returns True if a request was sent to the server to latch the specified group.

False

The XkbLatchGroup function returns False if the request was not sent.

History

  • Arch Linux 2026-11-01: the text shown here
  • Debian 13 (Trixie)
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)
  • Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze)
  • Debian 5.0 (Lenny)

From libx11 1.8.14-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.