XkbGetNames(3)

📦
version 1.8.14 · 8 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

✨ XkbGetNames ✨

okay so bestie, welcome to XkbGetNames(3) — a little function from the XKB FUNCTIONS corner of the libX11 universe, and honestly? it's giving "the server has the lore and I need it" 💅

🎀 NAME 🎀

XkbGetNames — Obtain symbolic names from the server 🌸

like, it goes and gets the names. from the server. that's the whole vibe, no cap.

🦋 SYNOPSIS 🦋

Status XkbGetNames (Display *dpy, unsigned int which, XkbDescPtr xkb);

💖 ARGUMENTS 💖

  • dpy — your connection to the X server, iykyk 🫶
  • which — a mask of names or map components that you want to be updated ✨
  • xkb — the keyboard description that's gonna get updated, main character energy 👑

🌈 DESCRIPTION 🌈

so XkbGetNames retrieves symbolic names for the components of the keyboard extension from the X server, fr fr. the which parameter specifies which name components get updated inside the xkb parameter, and it's the bitwise inclusive OR of the valid names mask bits defined in Table 1, bestie 🧚

⭐ Table 1 — Symbolic Names Masks ⭐

  • XkbKeycodesNameMask — (1<<0) — Xkb->names — keycodes
  • XkbGeometryNameMask — (1<<1) — Xkb->names — geometry
  • XkbSymbolsNameMask — (1<<2) — Xkb->names — symbols
  • XkbPhysSymbolsNameMask — (1<<3) — Xkb->names — phys_symbols
  • XkbTypesNameMask — (1<<4) — Xkb->names — type
  • XkbCompatNameMask — (1<<5) — Xkb->names — compat
  • XkbKeyTypeNamesMask — (1<<6) — Xkb->map — type[*].name
  • XkbKTLevelNamesMask — (1<<7) — Xkb->map — type[*].lvl_names[*]
  • XkbIndicatorNamesMask — (1<<8) — Xkb->names — indicators[*]
  • XkbKeyNamesMask — (1<<9) — Xkb->names — keys[*], num_keys
  • XkbKeyAliasesMask — (1<<10) — Xkb->names — key_aliases[*], num_key_aliases
  • XkbVirtualModNamesMask — (1<<11) — Xkb->names — vmods[*]
  • XkbGroupNamesMask — (1<<12) — Xkb->names — groups[*]
  • XkbRGNamesMask — (1<<13) — Xkb->names — radio_groups[*], num_rg
  • XkbComponentNamesMask — (0x3f) — Xkb->names — keycodes, geometry, symbols, physical symbols, types, and compatibility map
  • XkbAllNamesMask — (0x3fff) — Xkb->names — all name components

like… that's the whole menu, and yes you can OR them together 🍓

now for the fun part, the behavior 👀

if the names field of the keyboard description xkb is NULL, XkbGetNames allocates and initializes the names component of the keyboard description before obtaining the values specified by which ✨ it's literally doing setup for you, obsessed.

if the names field of xkb is not NULL, XkbGetNames obtains the values specified by which and copies them into the keyboard description Xkb 💜

🚨 heads up bestie: if the map component of the xkb parameter is NULL, XkbGetNames does not retrieve type or shift level names — even if XkbKeyTypeNamesMask or XkbKTLevelNamesMask are set in which. like it just won't. don't come for her 😭

XkbGetNames can return Success, or BadAlloc, BadLength, BadMatch, and BadImplementation errors.

and when you're done with your symbolic names and you wanna free them? use XkbFreeNames 🎀 (see SEE ALSO, she's linked below, periodt)

💅 DIAGNOSTICS 💅

  • BadAlloc — Unable to allocate storage 😭
  • BadImplementation — Invalid reply from server 💀
  • BadLength — The length of a request is shorter or longer than that required to minimally contain the arguments 🙈
  • 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 🔥

and that's the whole page, bestie! this iconic lil' manual page came to you straight from X Version 11, libX11 1.8.14 — go forth and get those names 👑💖✨

📦 where this page comes from