xcb_xkb_get_map(3)

✨ NAME ✨

xcb_xkb_get_map — okay so the manual name is XCB Requests, and honestly bestie, the original NAME line just says xcb_xkb_get_map - and then… nothing. No description. Iconic of it to show up with no caption. 💅 Anyway, this is a libxcb page, section 3, and it's all about asking the X server for a keyboard map.

---

🦋 SYNOPSIS 🦋

#include <xcb/xkb.h>

💖 Request function 💖

xcb_xkb_get_map_cookie_t xcb_xkb_get_map(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec, uint16_t full,
       uint16_t partial, uint8_t firstType, uint8_t nTypes,
       xcb_keycode_t firstKeySym, uint8_t nKeySyms,
       xcb_keycode_t firstKeyAction, uint8_t nKeyActions,
       xcb_keycode_t firstKeyBehavior, uint8_t nKeyBehaviors,
       uint16_t virtualMods, xcb_keycode_t firstKeyExplicit,
       uint8_t nKeyExplicit, xcb_keycode_t firstModMapKey,
       uint8_t nModMapKeys, xcb_keycode_t firstVModMapKey,
       uint8_t nVModMapKeys);

🎀 Reply datastructure 🎀

typedef struct xcb_xkb_get_map_reply_t {
    uint8_t       response_type;
    uint8_t       deviceID;
    uint16_t      sequence;
    uint32_t      length;
    uint8_t       pad0[2];
    xcb_keycode_t minKeyCode;
    xcb_keycode_t maxKeyCode;
    uint16_t      present;
    uint8_t       firstType;
    uint8_t       nTypes;
    uint8_t       totalTypes;
    xcb_keycode_t firstKeySym;
    uint16_t      totalSyms;
    uint8_t       nKeySyms;
    xcb_keycode_t firstKeyAction;
    uint16_t      totalActions;
    uint8_t       nKeyActions;
    xcb_keycode_t firstKeyBehavior;
    uint8_t       nKeyBehaviors;
    uint8_t       totalKeyBehaviors;
    xcb_keycode_t firstKeyExplicit;
    uint8_t       nKeyExplicit;
    uint8_t       totalKeyExplicit;
    xcb_keycode_t firstModMapKey;
    uint8_t       nModMapKeys;
    uint8_t       totalModMapKeys;
    xcb_keycode_t firstVModMapKey;
    uint8_t       nVModMapKeys;
    uint8_t       totalVModMapKeys;
    uint8_t       pad1;
    uint16_t      virtualMods;
} xcb_xkb_get_map_reply_t;

🌈 Reply function 🌈

xcb_xkb_get_map_reply_t *xcb_xkb_get_map_reply(xcb_connection_t *conn,
       xcb_xkb_get_map_cookie_t cookie, xcb_generic_error_t **e);

🌸 Reply accessors 🌸

xcb_xkb_get_map_map_t *xcb_xkb_get_map_map (const
xcb_xkb_get_map_request_t *reply)

---

💅 REQUEST ARGUMENTS 💅

• conn — the XCB connection to X11. That's your link to the server, your little red string to the X11 universe, no cap.
• deviceSpec — TODO: NOT YET DOCUMENTED. bestie the docs did not show up for this one 😭
• full — TODO: NOT YET DOCUMENTED. fr fr nobody wrote it down.
• partial — TODO: NOT YET DOCUMENTED. the lore is missing.
• firstType — TODO: NOT YET DOCUMENTED. undocumented, we simply don't know.
• nTypes — TODO: NOT YET DOCUMENTED. not a single word.
• firstKeySym — TODO: NOT YET DOCUMENTED. the docs ghosted us.
• nKeySyms — TODO: NOT YET DOCUMENTED. same energy.
• firstKeyAction — TODO: NOT YET DOCUMENTED. no notes left behind.
• nKeyActions — TODO: NOT YET DOCUMENTED. absent, like my will to study.
• firstKeyBehavior — TODO: NOT YET DOCUMENTED. still waiting on that explanation.
• nKeyBehaviors — TODO: NOT YET DOCUMENTED. never documented.
• virtualMods — TODO: NOT YET DOCUMENTED. the mystery continues.
• firstKeyExplicit — TODO: NOT YET DOCUMENTED. blank.
• nKeyExplicit — TODO: NOT YET DOCUMENTED. blank too.
• firstModMapKey — TODO: NOT YET DOCUMENTED. nope.
• nModMapKeys — TODO: NOT YET DOCUMENTED. nope nope.
• firstVModMapKey — TODO: NOT YET DOCUMENTED. nothing here either.
• nVModMapKeys — TODO: NOT YET DOCUMENTED. and we close the list on the same note 💀

---

👑 REPLY FIELDS 👑

• response_type — the type of this reply, which in this case is XCB_XKB_GET_MAP. This field is also present in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. Vibe check for packets ✨
• sequence — the sequence number of the last request processed by the X11 server. Your little receipt number 🧾
• length — the length of the reply, in words (and a word is 4 bytes, remember that bestie).
• deviceID — TODO: NOT YET DOCUMENTED. 😭
• minKeyCode — TODO: NOT YET DOCUMENTED. no notes.
• maxKeyCode — TODO: NOT YET DOCUMENTED. no notes.
• present — TODO: NOT YET DOCUMENTED. undoc'd.
• firstType — TODO: NOT YET DOCUMENTED. undoc'd.
• nTypes — TODO: NOT YET DOCUMENTED. undoc'd.
• totalTypes — TODO: NOT YET DOCUMENTED. undoc'd.
• firstKeySym — TODO: NOT YET DOCUMENTED. undoc'd.
• totalSyms — TODO: NOT YET DOCUMENTED. undoc'd.
• nKeySyms — TODO: NOT YET DOCUMENTED. undoc'd.
• firstKeyAction — TODO: NOT YET DOCUMENTED. undoc'd.
• totalActions — TODO: NOT YET DOCUMENTED. undoc'd.
• nKeyActions — TODO: NOT YET DOCUMENTED. undoc'd.
• firstKeyBehavior — TODO: NOT YET DOCUMENTED. undoc'd.
• nKeyBehaviors — TODO: NOT YET DOCUMENTED. undoc'd.
• totalKeyBehaviors — TODO: NOT YET DOCUMENTED. undoc'd.
• firstKeyExplicit — TODO: NOT YET DOCUMENTED. undoc'd.
• nKeyExplicit — TODO: NOT YET DOCUMENTED. undoc'd.
• totalKeyExplicit — TODO: NOT YET DOCUMENTED. undoc'd.
• firstModMapKey — TODO: NOT YET DOCUMENTED. undoc'd.
• nModMapKeys — TODO: NOT YET DOCUMENTED. undoc'd.
• totalModMapKeys — TODO: NOT YET DOCUMENTED. undoc'd.
• firstVModMapKey — TODO: NOT YET DOCUMENTED. undoc'd.
• nVModMapKeys — TODO: NOT YET DOCUMENTED. undoc'd.
• totalVModMapKeys — TODO: NOT YET DOCUMENTED. undoc'd.
• virtualMods — TODO: NOT YET DOCUMENTED. undoc'd.

bestie the reply fields really said "figure it out" 🙈 that's just how the original is, I'm not making it up, promise.

---

🌈 DESCRIPTION 🌈

Okay so. The DESCRIPTION section in the original is… empty. Nothing. A whole heading with no thoughts behind it. The silence is deafening 🦋

---

🫶 RETURN VALUE 🫶

It returns an xcb_xkb_get_map_cookie_t. And listen — errors have to be handled when you call the reply function xcb_xkb_get_map_reply.

But if you'd rather handle errors in the event loop instead, use xcb_xkb_get_map_unchecked. See xcb-requests(3) for the details, iykyk 💜

---

💀 ERRORS 💀

This request does never generate any errors. Not one. Zero. Clean sheet, flawless, ate and left no crumbs 👑

---

⭐ SEE ALSO ⭐

Nothing listed here in the original — the section exists and it's just vibes and blank space. 🌸

---

🎀 AUTHOR 🎀

Generated from xkb.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. (They really said "email us if it's wrong" and honestly, respect. 🫶)

---

And that's the whole page, bestie! This one comes from X Version 11, libxcb 1.17.0, and it lives in the manual as xcb_xkb_get_map(3). Go forth and map those keys, you absolute icon 💖✨🎀🦋