XkbGetKeyVirtualModMap(3)

✨ XkbGetKeyVirtualModMap(3) — XKB FUNCTIONS edition ✨

💖 NAME 💖

XkbGetKeyVirtualModMap — obtain the virtual modifier map (the vmodmap array) for a subset of the keys in a keyboard description. It’s giving “selective key gossip,” bestie. 💅

🦋 SYNOPSIS 🦋

Status XkbGetKeyVirtualModMap (Display *dpy, unsigned int first,
       unsigned int num, XkbDescPtr xkb);

🎀 ARGUMENTS 🎀

• dpy — connection to server. Obviously the server connection, no cap.
• first — keycode of first key to fetch. The starting point of the key lineup.
• num — number of keys for which virtual mod maps are desired. How many keys we’re pulling into the group chat.
• xkb — Xkb description where results will be placed. This is where the results go, periodt.

🌸 DESCRIPTION 🌸

Okay so XkbGetKeyVirutalModmap sends a request to the server to obtain the virtual modifier mappings for num keys on the keyboard starting with key first. It waits for a reply and returns the virtual modifier mappings in the server->vmodmap array of xkb. If successful, XkbGetKeyVirtualModMap returns Success. The xkb parameter must be a pointer to a valid Xkb keyboard description.

If the server map in the xkb parameter has not been allocated, XkbGetKeyVirtualModMap allocates and initializes it before obtaining the virtual modifier mappings. Very “I got you, bestie” of it. 🫶

If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyVirtualModMap returns BadMatch. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyVirtualModMap returns BadValue. If any allocation errors occur, XkbGetKeyVirtualModMap returns BadAlloc. So yeah, vibe check those args. 💀

🌈 RETURN VALUES 🌈

• Success — The XkbGetKeyVirutalModmap function returns Success following a successful reply from the server to obtain the virtual modifier mappings for num keys on the keyboard starting with key first. Iconic behavior. 👑

🔥 DIAGNOSTICS 🔥

• BadAlloc — Unable to allocate storage. Storage said “not today.” 😭
• BadMatch — A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid. It’s giving “right type, wrong vibe.” 🙈
• BadValue — An argument is out of range. Bestie, that value is outside the group chat. 🚫

---

🎀 Footer tea: X Version 11 · libX11 1.8.14 · no separate date field in this footer, just XkbGetKeyVirtualModMap(3) — bye bestie! 💅