xcb_xkb_get_named_indicator(3)

💖 xcb_xkb_get_named_indicator 💖

okay bestie so this is a page from the XCB Requests manual — the xcb_xkb_get_named_indicator(3) page, to be exact — and it's all about asking the X server "hey girl, what's up with this named indicator?" 🎀

---

✨ NAME ✨

xcb_xkb_get_named_indicator — and that's... literally it. The description line is empty. The manpage said nothing. It's giving mysterious. 🙈

---

🌸 SYNOPSIS 🌸

First things first, you gotta pull in the header:

#include <xcb/xkb.h>

🦋 Request function

xcb_xkb_get_named_indicator_cookie_t
       xcb_xkb_get_named_indicator(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec,
       xcb_xkb_led_class_spec_t ledClass, xcb_xkb_id_spec_t ledID,
       xcb_atom_t indicator);

🦋 Reply datastructure

this is the lil glow-up container that holds everything the server sends back:

typedef struct xcb_xkb_get_named_indicator_reply_t {
    uint8_t    response_type;
    uint8_t    deviceID;
    uint16_t   sequence;
    uint32_t   length;
    xcb_atom_t indicator;
    uint8_t    found;
    uint8_t    on;
    uint8_t    realIndicator;
    uint8_t    ndx;
    uint8_t    map_flags;
    uint8_t    map_whichGroups;
    uint8_t    map_groups;
    uint8_t    map_whichMods;
    uint8_t    map_mods;
    uint8_t    map_realMods;
    uint16_t   map_vmod;
    uint32_t   map_ctrls;
    uint8_t    supported;
    uint8_t    pad0[3];
} xcb_xkb_get_named_indicator_reply_t;

🦋 Reply function

xcb_xkb_get_named_indicator_reply_t
       *xcb_xkb_get_named_indicator_reply(xcb_connection_t *conn,
       xcb_xkb_get_named_indicator_cookie_t cookie,
       xcb_generic_error_t **e);

---

💅 REQUEST ARGUMENTS 💅

the way you gotta hand these over when you fire off the request:

• conn — your XCB connection to X11. it's the whole link to the server, no cap. 💜
• deviceSpec — TODO: NOT YET DOCUMENTED. bestie, the docs just straight-up ghosted us on this one 😭
• ledClass — TODO: NOT YET DOCUMENTED. also a mystery ✨
• ledID — TODO: NOT YET DOCUMENTED. still nothing 🫶
• indicator — TODO: NOT YET DOCUMENTED. the void is voiding 💀

---

🔥 REPLY FIELDS 🔥

here's everything the reply struct hands back to you:

• response_type — the type of this reply, and in this case it's XCB_XKB_GET_NAMED_INDICATOR. this field also lives in the xcb_generic_reply_t, and it's literally how you tell your replies apart from each other. iconic. 👑
• sequence — the sequence number of the last request that got processed by the X11 server. the receipts, basically. 🧾
• length — how long the reply is, in words. and a word is 4 bytes, iykyk. 📏
• deviceID — TODO: NOT YET DOCUMENTED. 🙈
• indicator — TODO: NOT YET DOCUMENTED. 🙈
• found — TODO: NOT YET DOCUMENTED. 🙈
• on — TODO: NOT YET DOCUMENTED. 🙈
• realIndicator — TODO: NOT YET DOCUMENTED. 🙈
• ndx — TODO: NOT YET DOCUMENTED. 🙈
• map_flags — TODO: NOT YET DOCUMENTED. 🙈
• map_whichGroups — TODO: NOT YET DOCUMENTED. 🙈
• map_groups — TODO: NOT YET DOCUMENTED. 🙈
• map_whichMods — TODO: NOT YET DOCUMENTED. 🙈
• map_mods — TODO: NOT YET DOCUMENTED. 🙈
• map_realMods — TODO: NOT YET DOCUMENTED. 🙈
• map_vmod — TODO: NOT YET DOCUMENTED. 🙈
• map_ctrls — TODO: NOT YET DOCUMENTED. 🙈
• supported — TODO: NOT YET DOCUMENTED. 🙈

---

🌈 DESCRIPTION 🌈

...and that's it. the DESCRIPTION section is empty. no prose, no lore, nothing. it's giving minimalism, bestie. 💀✨

---

⭐ RETURN VALUE ⭐

you get back an xcb_xkb_get_named_indicator_cookie_t. 🍪 and here's the tea — errors have to be handled over on the reply function, xcb_xkb_get_named_indicator_reply.

but wait, if you'd rather catch your errors in the event loop instead? use xcb_xkb_get_named_indicator_unchecked. slay. and peep xcb-requests(3) for all the deets on that. 🫶

---

💀 ERRORS 💀

this request never generates any errors. zero. none. not a single one. we love a low-drama request. 😌

---

🦄 SEE ALSO 🦄

nothing here either bestie — the SEE ALSO section is empty, so you're on your own (but fr fr, you've got this). 💖

---

🎀 AUTHOR 🎀

generated from xkb.xml. and if you spot something wrong or wanna make it better, hit up xcb@lists.freedesktop.org for corrections and improvements. 🫶

---

okay that's the whole page, bestie — stay iconic, and remember: the docs may be empty but your potential is not ✨💅🌸

this cutie came to you from X Version 11, running libxcb 1.17.0, filed under xcb_xkb_get_named_indicator(3). mwah, love u, bye! 💖🎀🦋