xcb_ungrab_key(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_ungrab_key — release a key combination 💖

okay so bestie, welcome to the xcb_ungrab_key(3) page, part of the XCB Requests crew 🎀 this one is short and sweet and honestly kind of a palate cleanser after the chaos that is grabbing. let's get into it 💅

✨ SYNOPSIS ✨

first things first, you gotta pull in the header:

#include <xcb/xproto.h>

🦋 Request function

xcb_void_cookie_t xcb_ungrab_key(xcb_connection_t *conn,
       xcb_keycode_t key, xcb_window_t grab_window, uint16_t modifiers);

that's it, that's the whole vibe. one function, four args, zero drama 🌸

🌈 REQUEST ARGUMENTS 🌈

  • conn — the XCB connection to X11. your lil lifeline to the server, the group chat you're posting in 💖
  • key — the keycode of the specified key combination. lowkey important detail: if you use the special value XCB_GRAB_ANY, you're releasing all possible key codes at once. like, every single one. icon behavior honestly 👑
  • grab_window — the window on which the grabbed key combination will be released. this is the spot where the un-grabbing happens 🪟✨
  • modifiers — the modifiers of the specified key combination. and here's the tea: using the special value XCB_MOD_MASK_ANY means you're releasing the key combination with every possible modifier combination. Ctrl? Shift? Alt? all of them, bestie. the whole squad 💅

🎀 DESCRIPTION 🎀

so basically: xcb_ungrab_key releases the key combination on grab_window if you grabbed it using xcb_grab_key before. that's the whole thing. you grabbed it, now you're letting it go. it's giving closure 🦋

💀 RETURN VALUE 💀

it returns an xcb_void_cookie_t. no cap. and because it's void, any errors (if there are any) have to be handled in the event loop — you don't get them handed to you directly, you gotta go looking 👀

if you want to handle errors directly with xcb_request_check instead, use xcb_ungrab_key_checked. same energy, just more upfront about its problems 🙈 see xcb-requests(3) for the details.

😭 ERRORS 😭

  • xcb_value_error_t — TODO: reasons? yeah bestie, the docs themselves said "idk" on this one 💀 we're all just vibing
  • xcb_window_error_t — the specified grab_window does not exist. it's not there. it ghosted you 👻

👑 SEE ALSO 👑

💜 AUTHOR 💜

generated from xproto.xml. got corrections or improvements? contact xcb@lists.freedesktop.org — they're literally taking submissions, go off 🫶

and that's the page, bestie ✨ this was xcb_ungrab_key(3) from X Version 11, brought to you by libxcb 1.17.0. thanks for reading, now go release that key combo, you absolute main character 🌟🎀🦋

📦 where this page comes from