xcb_xkb_get_names(3)

💖 xcb_xkb_get_names — bestie edition 💖

okay so this is xcb_xkb_get_names(3), from the XCB Requests squad, and we're about to get into it. grab a snack. 🍓

---

✨ NAME ✨

xcb_xkb_get_names — and honestly? the description is just... nothing. empty. a blank. the manpage left it wide open and said "you figure it out". iconic of it, honestly. 💀

---

🦋 SYNOPSIS 🦋

first things first, you gotta bring in the header:

#include <xcb/xkb.h>

🎀 Request function

xcb_xkb_get_names_cookie_t xcb_xkb_get_names(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec, uint32_t which);

🎀 Reply datastructure

this is the struct, and yes, every single field matters, don't skip any:

typedef struct xcb_xkb_get_names_reply_t {
    uint8_t       response_type;
    uint8_t       deviceID;
    uint16_t      sequence;
    uint32_t      length;
    uint32_t      which;
    xcb_keycode_t minKeyCode;
    xcb_keycode_t maxKeyCode;
    uint8_t       nTypes;
    uint8_t       groupNames;
    uint16_t      virtualMods;
    xcb_keycode_t firstKey;
    uint8_t       nKeys;
    uint32_t      indicators;
    uint8_t       nRadioGroups;
    uint8_t       nKeyAliases;
    uint16_t      nKTLevels;
    uint8_t       pad0[4];
} xcb_xkb_get_names_reply_t;

🎀 Reply function

xcb_xkb_get_names_reply_t
       *xcb_xkb_get_names_reply(xcb_connection_t *conn,
       xcb_xkb_get_names_cookie_t cookie, xcb_generic_error_t **e);

🎀 Reply accessors

xcb_xkb_get_names_value_list_t *xcb_xkb_get_names_value_list (const
xcb_xkb_get_names_request_t *reply)

---

🌸 REQUEST ARGUMENTS 🌸

• conn — the XCB connection to X11. your lil phone line to the server, basically. 🫶
• deviceSpec — TODO: NOT YET DOCUMENTED. yeah babe, the manpage just left us on read. 🙈
• which — TODO: NOT YET DOCUMENTED. also ghosted. 💀

---

🌈 REPLY FIELDS 🌈

• response_type — the type of this reply, which in this case is XCB_XKB_GET_NAMES. this field is also chillin' inside xcb_generic_reply_t, and you can use it to tell replies apart from each other. it's the name tag at the party. 👑
• sequence — the sequence number of the last request processed by the X11 server. lowkey the server's little "last seen at" timestamp. ✨
• length — the length of the reply, in words. and reminder: a word is 4 bytes. 🎀
• deviceID — TODO: NOT YET DOCUMENTED.
• which — TODO: NOT YET DOCUMENTED.
• minKeyCode — TODO: NOT YET DOCUMENTED.
• maxKeyCode — TODO: NOT YET DOCUMENTED.
• nTypes — TODO: NOT YET DOCUMENTED.
• groupNames — TODO: NOT YET DOCUMENTED.
• virtualMods — TODO: NOT YET DOCUMENTED.
• firstKey — TODO: NOT YET DOCUMENTED.
• nKeys — TODO: NOT YET DOCUMENTED.
• indicators — TODO: NOT YET DOCUMENTED.
• nRadioGroups — TODO: NOT YET DOCUMENTED.
• nKeyAliases — TODO: NOT YET DOCUMENTED.
• nKTLevels — TODO: NOT YET DOCUMENTED.

not me listing out every single one of those TODOs 💅 the docs said "figure it out yourself" and meant it fr fr.

---

💜 DESCRIPTION 💜

...and that's it. that's the whole section. the DESCRIPTION is literally empty. the void. the silence. she said nothing and left. 😭

---

🧚 RETURN VALUE 🧚

so you get back an xcb_xkb_get_names_cookie_t. it's a cookie, not the answer — you gotta go pick up the answer later. 🍪

errors? they have to be handled when you call the reply function xcb_xkb_get_names_reply.

and if you'd rather handle errors in the event loop instead of right there, use xcb_xkb_get_names_unchecked. see xcb-requests(3) for the deets. 📖

---

🫶 ERRORS 🫶

this request does never generate any errors. zero. none. she's drama-free, she's unproblematic, she ate and left no crumbs. ✨

---

⭐ SEE ALSO ⭐

(that's it bestie, the list is empty, the manpage had nothing to link and honestly? respect.) 🎀

---

👑 AUTHOR 👑

generated from xkb.xml. contact xcb@lists.freedesktop.org for corrections and improvements. go tell them if something's off, they're nice about it. 💖

---

and that's the whole vibe check! 🌟 this was written against X Version 11 and libxcb 1.17.0, page xcb_xkb_get_names(3) — stay hydrated, read your manpages, and remember: TODO: NOT YET DOCUMENTED is a mood. 💅✨🌸