XkbFreeGeomOverlayRows(3)

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

💖 NAME 💖

XkbFreeGeomOverlayRows(3) — Free rows in an overlay, bestie. This one lives in the XKB FUNCTIONS manual, section 3, and it's giving very specific cleanup energy. 💅

🌸 SYNOPSIS 🌸

void XkbFreeGeomOverlayRows (XkbSectionPtr overlay, int first, int count, Bool free_all);

🎀 ARGUMENTS 🎀

  • overlay — the section in which rows should be freed. That's the main-character section, iykyk.
  • first — the first row to be freed.
  • count — the number of rows to be freed.
  • free_all — True => all rows are freed. Yep, that's the whole mood.

🦋 DESCRIPTION 🦋

Okay so Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. ✨

Important vibe check: these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase sz_* but never touch num_* — unless there is an allocation failure, in which case they reset both sz_* and num_* to zero. No cap, that's the rule. 💀

These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected.

If free_all is True, all rows are freed regardless of the value of first and count. Otherwise, the number of rows specified by count are freed, beginning with the row specified by first in the specified overlay. Slay. 🫶

⭐ RETURN VALUES ⭐

  • Success — The XkbFreeGeomOverlayRows function returns Success if there are no allocation or argument errors. Iconic.

💀 DIAGNOSTICS 💀

  • BadAlloc — Unable to allocate storage.
  • BadValue — An argument is out of range.

Signed, sealed, delivered from X Version 11 / libX11 1.8.14 — no date printed on this page, so I'm not inventing one, bestie 💅✨

📦 where this page comes from