XkbGetCompatMap(3)

💅 NAME

XkbGetCompatMap — grab any combo of the current compatibility map components straight off the server, bestie ✨

---

🎀 SYNOPSIS

Status XkbGetCompatMap (Display *display, unsigned int which, XkbDescRec *xkb);

---

🫶 ARGUMENTS

• display — the connection to the server, obviously 💖
• which — the mask of which compatibility map components you wanna fetch
• xkb — the keyboard description where the results get placed

---

🦋 DESCRIPTION

Okay so here's the lore: when another client goes and modifies the compatibility map, you get notified — but only if you've selected for XkbCompatMapNotify events. And XkbGetCompatMap is literally the moment for this, because it lets you update your program's version of the compatibility map so it matches the modified version that's now chillin' in the server. Iconic. And if your program is juggling multiple servers and needs to configure them all the same way? The updated compatibility map can be used to reconfigure the other servers too. Slay 🌈

XkbGetCompatMap fetches the components of the compatibility map that you specified in which, from the server specified by display, and drops them into the compat structure of the keyboard description xkb. Valid values for which are an inclusive OR of the values in Table 1 💅

✨ Table 1: Compatibility Map Component Masks ✨

• XkbSymInterpMask — value (1<<0) — affecting: Symbol interpretations
• XkbGroupCompatMask — value (1<<1) — affecting: Group maps
• XkbAllCompatMask — value (0x3) — affecting: All compatibility map components

So if there's no compatibility map structure allocated in xkb when you come in, XkbGetCompatMap allocates one for you 🎁 If one already exists? Its contents get overwritten with the returned results. No cap.

XkbGetCompatMap fetches compatibility map info for the device specified by the device_spec field of xkb. Unless you specifically modified that field, it's the default keyboard device. Standard behavior, iykyk.

And the return tea ☕: XkbGetCompatMap returns Success if successful, BadAlloc if it can't obtain the necessary storage for either the return values or work space, BadMatch if the dpy field of the xkb argument is non-NULL and doesn't match the display argument, and BadLength under certain conditions caused by server or Xkb implementation errors. 💀

---

🔥 DIAGNOSTICS

• BadAlloc — unable to allocate storage 😭
• BadLength — the length of a request is shorter or longer than that required to minimally contain the arguments
• BadMatch — a compatible version of Xkb was not available in the server, or an argument has correct type and range but is otherwise invalid 🙈

---

fr fr, that's the whole page — every mask, every error, nothing skipped 💜

okay bye bestie, this page came from X Version 11, libX11 1.8.14, and it's the XkbGetCompatMap(3) era of your life now 👑✨