xcb_xkb_get_indicator_map(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_map — the manual page, bestie edition 💅

okay so this is the xcb_xkb_get_indicator_map page from the XCB Requests family, and it's basically your group chat with the X11 server asking "hey babes, what's the indicator map looking like rn?" 🎀✨

✨ NAME ✨

xcb_xkb_get_indicator_map — (the description slot in the original is literally empty, so like… that's the vibe. it's giving mystery. 🕵️♀️)

🌸 SYNOPSIS 🌸

#include <xcb/xkb.h>

🦋 Request function

xcb_xkb_get_indicator_map_cookie_t
       xcb_xkb_get_indicator_map(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec, uint32_t which);

🦋 Reply datastructure

typedef struct xcb_xkb_get_indicator_map_reply_t {
    uint8_t  response_type;
    uint8_t  deviceID;
    uint16_t sequence;
    uint32_t length;
    uint32_t which;
    uint32_t realIndicators;
    uint8_t  nIndicators;
    uint8_t  pad0[15];
} xcb_xkb_get_indicator_map_reply_t;

🦋 Reply function

xcb_xkb_get_indicator_map_reply_t
       *xcb_xkb_get_indicator_map_reply(xcb_connection_t *conn,
       xcb_xkb_get_indicator_map_cookie_t cookie,
       xcb_generic_error_t **e);

🦋 Reply accessors

xcb_xkb_indicator_map_t *xcb_xkb_get_indicator_map_maps(const
       xcb_xkb_get_indicator_map_request_t *reply);

int xcb_xkb_get_indicator_map_maps_length(const
       xcb_xkb_get_indicator_map_reply_t *reply);

xcb_xkb_indicator_map_iterator_t
       xcb_xkb_get_indicator_map_maps_iterator(const
       xcb_xkb_get_indicator_map_reply_t *reply);

🌈 REQUEST ARGUMENTS 🌈

  • conn — bestie, this is The XCB connection to X11. your whole link to the server, your main character connection. 💖
  • deviceSpec — TODO: NOT YET DOCUMENTED. yeah the docs really just left us on read for this one 😭
  • which — TODO: NOT YET DOCUMENTED. also ghosted us fr fr 🙈

💜 REPLY FIELDS 💜

  • response_type — the type of this reply, and in this case it's XCB_XKB_GET_INDICATOR_MAP. this field is also chillin' inside the xcb_generic_reply_t, so you can use it to tell replies apart from each other. it's the little name tag at the party 🎀
  • sequence — the sequence number of the last request processed by the X11 server. it's the receipts of "yes i got to your message" ✨
  • length — the length of the reply, measured in words (and a word here is 4 bytes, no cap). 📏
  • deviceID — TODO: NOT YET DOCUMENTED. 💀
  • which — TODO: NOT YET DOCUMENTED. 💀
  • realIndicators — TODO: NOT YET DOCUMENTED. 💀
  • nIndicators — TODO: NOT YET DOCUMENTED. 💀

🫶 DESCRIPTION 🫶

(okay so the original DESCRIPTION section is completely empty. nothing. zero. silence. not me staring at a blank section like 👁️👄👁️ — anyway, moving on bestie)

⭐ RETURN VALUE ⭐

Returns an xcb_xkb_get_indicator_map_cookie_t, iconic. 🍪

Errors have to be handled when you call the reply function xcb_xkb_get_indicator_map_reply.

But if you'd rather handle your errors in the event loop instead, use xcb_xkb_get_indicator_map_unchecked. see xcb-requests(3) for the deets, iykyk. 💅

🔥 ERRORS 🔥

This request does never generate any errors.

yup, she's clean. zero drama, zero errors. we love a low-maintenance request. 😌✨

🌟 SEE ALSO 🌟

(the original SEE ALSO section is empty — no references, nothing. just vibes. 🦋)

👑 AUTHOR 👑

Generated from xkb.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. they're literally asking for your feedback, bestie, so don't be shy 🫶

and that's the whole page!! mwah 💋 this little gem comes to you from X Version 11 and libxcb 1.17.0 — periodt, slay, go read some more manpages, ily 💖✨🎀🦋

📦 where this page comes from