XkbFreeGeomKeyAliases(3)

πŸ¦‹ XkbFreeGeomKeyAliases β€” from the XKB FUNCTIONS manual πŸ¦‹

✨ NAME ✨

XkbFreeGeomKeyAliases β€” free geometry key aliases. That's it, that's the job, and it ate. πŸ’…


🌈 SYNOPSIS 🌈

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

πŸŽ€ ARGUMENTS πŸŽ€

  • geom β€” the geometry where the key aliases should be freed, bestie.
  • first β€” the first key alias to be freed.
  • count β€” how many key aliases to free.
  • free_all β€” True => all key aliases are freed. Like, all of them, no cap.

πŸ’– DESCRIPTION πŸ’–

Okay so Xkb provides a whole crew 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. They're giving scaffolding, not finished lewk. ✨

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. So yeah, failure is dramatic like that. 😭

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 aliases in the top level of the specified geometry geom are freed regardless of the value of first or count. Otherwise, count aliases in geom are freed beginning with the one specified by first. So don't come for first and count when free_all is already doing the most. πŸ‘‘


πŸ‘‘ RETURN VALUES πŸ‘‘

  • Success β€” The XkbFreeGeomKeyAliases function returns Success if there are no allocation errors. Slay. βœ…

πŸ’€ DIAGNOSTICS πŸ’€

  • BadAlloc β€” Unable to allocate storage. Storage said no. πŸ™ˆ
  • BadValue β€” An argument is out of range. Rude, but valid. 🚩

and that's the whole page, bestie 🫢 β€” brought to you by the footer's X Version 11 / libX11 1.8.14 source/version info and the XkbFreeGeomKeyAliases(3) page name β€” no separate date printed, so that's the whole footer tea. πŸ΅πŸŽ€

πŸ“¦ where this page comes from