XkbAllocGeomKeyAliases(3)

hey bestie 💖 welcome to the XkbAllocGeomKeyAliases(3) page — it lives in the XKB FUNCTIONS manual, and it's here to explain how to allocate geometry key aliases. Let's get into it ✨

🎀 NAME 🎀

XkbAllocGeomKeyAliases — allocate geometry key aliases

✨ SYNOPSIS ✨

Status XkbAllocGeomKeyAliases (XkbGeometryPtr geom, int num_needed);

💅 ARGUMENTS 💅

• geom — the geometry for which key aliases should be allocated. Like, this is the geometry that's getting the new alias space, bestie.
• num_needed — number of new key aliases required. That's how many slots you're asking for.

🦋 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. And listen: these functions merely allocate space for the new element(s) — it is up to you to fill in the values explicitly in your code. No autofill, no vibes-only initialization, you actually have to write the values yourself 💀

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

XkbAllocGeomKeyAliases allocates space for num_needed key aliases and adds them to the specified geometry geom. A key alias is a pair of strings that associates an alternate name for a key with the real name for that key. Cute, right? It's basically a nickname registry for keys 💖

To free geometry key aliases, use XkbFreeGeomKeyAliases.

🌸 DIAGNOSTICS 🌸

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

🌈 SEE ALSO 🌈

XkbFreeGeomKeyAliases(3) — go free those aliases when you're done, bestie 💅

---

okay that's the whole page, bestie — mwah 💋✨ the footer vibes are X Version 11 and libX11 1.8.14, and this iconic little page is XkbAllocGeomKeyAliases(3) 🫶