XkbFreeGeomSections(3)

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

✨ XkbFreeGeomSections(3) ✨

okay so this is a page from the XKB FUNCTIONS corner of the libX11 universe, and it's about freeing geometry sections — yes bestie, we're doing memory management today 💅

💖 NAME 💖

XkbFreeGeomSections — free geometry sections 🎀

🦋 SYNOPSIS 🦋

void XkbFreeGeomSections (XkbGeometryPtr geom, int first, int count,
       Bool free_all);

🌸 ARGUMENTS 🌸

  • geom — the geometry where the sections you wanna free are living
  • first — which section is first up for freeing
  • count — how many sections you're freeing, periodt
  • free_all — True => literally every section gets freed

⭐ DESCRIPTION ⭐

So Xkb hands you a whole lil family of functions for allocating and freeing subcomponents of a keyboard geometry — and this is one of them, bestie 🫶. You use these functions to create or modify keyboard geometries.

⚠️ heads up, this part matters: these functions merely allocate space for the new element(s). It is completely up to you to fill in the values explicitly in your code. The function is not gonna do it for you, no cap 😭

The allocation functions increase sz_* but never touch num_* — unless there's an allocation failure, in which case they reset both sz_* and num_* to zero 💀. And these functions return Success if they succeed, BadAlloc if they can't allocate space, or BadValue if a parameter isn't what was expected.

Now for the actual behavior, because this is the good part ✨:

  • If free_all is True, all sections are freed, regardless of what first and count say. They simply don't get a vote 💅
  • Otherwise, the number of sections specified by count get freed, beginning with the section specified by first in the geometry you passed in.

👑 RETURN VALUES 👑

  • Success — the XkbFreeGeomSections function returns Success when there are no allocation or argument errors. iconic behavior, honestly 🌈

🔥 DIAGNOSTICS 🔥

  • BadAlloc — unable to allocate storage 😭
  • BadValue — an argument is out of range 🙈

🎀 SEE ALSO 🎀

(nothing else listed on this page — this one's a solo main character ⭐)

and that's the whole page, bestie! this one comes to you from X Version 11, libX11 1.8.14 — go forth and free your sections responsibly, mwah 💖🧚‍♀️

📦 where this page comes from