XkbFreeGeomOverlayKeys(3)

✨ NAME ✨

XkbFreeGeomOverlayKeys β€” free keys in an overlay row πŸ’…

This is your XkbFreeGeomOverlayKeys(3) page, bestie, hangin' out in the XKB FUNCTIONS manual. Let's get into it 🫢


✨ SYNOPSIS ✨

void XkbFreeGeomOverlayKeys (XkbRowPtr row, int first, int count, Bool
       free_all);

✨ ARGUMENTS ✨

  • row β€” the row where the keys should be freed, like, that's the target 🎯
  • first β€” the first key to be freed
  • count β€” how many keys to free
  • free_all β€” True => all keys are freed

✨ DESCRIPTION ✨

Okay so Xkb gives you a whole little crew of functions for allocating and freeing subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries ✨

Heads up though: 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. Like, the space is reserved, but the actual values? That's your job, bestie 😌

The 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. So dramatic, but okay πŸ’€

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.

And for the actual freeing behavior: if free_all is True, all keys are freed regardless of the value of first and count. Otherwise, the number of keys specified by count are freed, beginning with the key specified by first in the specified row. Slay, precision πŸŽ€


✨ RETURN VALUES ✨

  • Success β€” The XkbFreeGeomOverlayKeys function returns Success if there are no allocation or argument errors. Iconic, no notes πŸ‘‘

✨ DIAGNOSTICS ✨

  • BadAlloc β€” Unable to allocate storage 😭
  • BadValue β€” An argument is out of range 🚩

Mwah πŸ’‹ β€” footer flava: X Version 11, libX11 1.8.14, and XkbFreeGeomOverlayKeys(3), periodt. Bye bestie πŸ«ΆπŸ’œ

πŸ“¦ where this page comes from