xcb_xkb_get_indicator_state(3)

📦
version 1.17.0 · 4 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, debian trixie, fedora 43, fedora 44, nixpkgs unstable, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 xcb_xkb_get_indicator_state — the whole manual, bestie 💖

okay so bestie, we're looking at xcb_xkb_get_indicator_state(3) from the XCB Requests crew. yes that's the manual name, no I will not be saying it three times fast. let's get into it 💅

✨ NAME ✨

xcb_xkb_get_indicator_state — and that's literally it. the og page leaves the description blank, so like… the name is the name. iconic behaviour tbh. 🎀

✨ SYNOPSIS ✨

first things first, you gotta pull in the header:

#include <xcb/xkb.h>

🦋 Request function

xcb_xkb_get_indicator_state_cookie_t
       xcb_xkb_get_indicator_state(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec);

🦋 Reply datastructure

typedef struct xcb_xkb_get_indicator_state_reply_t {
    uint8_t  response_type;
    uint8_t  deviceID;
    uint16_t sequence;
    uint32_t length;
    uint32_t state;
    uint8_t  pad0[20];
} xcb_xkb_get_indicator_state_reply_t;

🦋 Reply function

xcb_xkb_get_indicator_state_reply_t
       *xcb_xkb_get_indicator_state_reply(xcb_connection_t *conn,
       xcb_xkb_get_indicator_state_cookie_t cookie,
       xcb_generic_error_t **e);

🌸 REQUEST ARGUMENTS 🌸

  • conn — your XCB connection to X11. the whole link to the server, the vibe carrier, the moment. ✨
  • deviceSpec — okay so… the original literally says TODO: NOT YET DOCUMENTED. 😭 bestie they left it blank. no cap. I'm not gonna make something up because that would be lying and lying is not the move. 👑

💜 REPLY FIELDS 💜

  • response_type — the type of this reply, and in this case it's XCB_XKB_GET_INDICATOR_STATE. this field is also chillin' inside xcb_generic_reply_t, so you can use it to tell your replies apart from each other. like name tags at a party but for packets. 🎀
  • sequence — the sequence number of the last request the X11 server processed. the receipts, basically. 🧾
  • length — how long the reply is, in words. and a word here is 4 bytes, so don't come at it with your English-major definition of "word". 💀
  • deviceID — TODO: NOT YET DOCUMENTED. yeah. blank again. 🙈
  • state — TODO: NOT YET DOCUMENTED. three for three, the og page said nothing, and I respect the mystery honestly. ✨

🌈 DESCRIPTION 🌈

this section is empty in the original. like, genuinely empty. nothing. void. the silence is deafening fr fr. so I have nothing to tell you here and I'm not about to invent lore. 🫶

⭐ RETURN VALUE ⭐

so this one returns an xcb_xkb_get_indicator_state_cookie_t. and listen — errors have to be handled when you call the reply function xcb_xkb_get_indicator_state_reply. that's the deal, bestie.

but if you'd rather handle errors in the event loop instead? use xcb_xkb_get_indicator_state_unchecked. see xcb-requests(3) for the details on how that whole thing works. 🔥

🍓 ERRORS 🍓

the tea: this request never generates any errors. zero. none. not a single one. it's giving peaceful. 🕊️

🧚 SEE ALSO 🧚

(nothing listed in the original — this section is empty too. the og page is a minimalist, and honestly? main character energy.) 💅

👑 AUTHOR 👑

Generated from xkb.xml. got corrections or improvements? contact xcb@lists.freedesktop.org — they're the ones to slide into the inbox of. 📬

and that's the whole thing, bestie!! this page came to you from X Version 11, libxcb 1.17.0 — mwah, slay, go read the source, periodt. 💖✨🎀🦋

📦 where this page comes from