xcb_xkb_latch_lock_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_latch_lock_state β€” the XCB Requests era

okay so bestie, welcome to xcb_xkb_latch_lock_state(3), a lil function from the XCB Requests corner of libxcb. sit down, grab a boba, we're latching and locking states like it's nothing πŸŽ€

Fair warning before we even start: the NAME section of this page is literally just the function name with nothing after it. No little summary, no tagline, no vibe. She's mysterious. We move. ✨


✨ SYNOPSIS ✨

First things first, you gotta pull in the header:

#include <xcb/xkb.h>

🌸 Request function

xcb_void_cookie_t xcb_xkb_latch_lock_state(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec, uint8_t affectModLocks,
       uint8_t modLocks, uint8_t lockGroup, uint8_t groupLock,
       uint8_t affectModLatches, uint8_t latchGroup,
       uint16_t groupLatch);

Look at that signature. Nine parameters. She's high maintenance and honestly? iconic. πŸ’…


🫢 REQUEST ARGUMENTS 🫢

  • conn β€” the XCB connection to X11. your link to the mothership, your group chat with the X server, no conn no nothing πŸ’–
  • deviceSpec β€” TODO: NOT YET DOCUMENTED. yeah. the docs said "we'll get to it" and then never did 😭
  • affectModLocks β€” TODO: NOT YET DOCUMENTED. same energy ngl
  • modLocks β€” TODO: NOT YET DOCUMENTED. the mystery continues
  • lockGroup β€” TODO: NOT YET DOCUMENTED. she's keeping secrets
  • groupLock β€” TODO: NOT YET DOCUMENTED. truly not yet documented fr fr
  • affectModLatches β€” TODO: NOT YET DOCUMENTED. yep
  • latchGroup β€” TODO: NOT YET DOCUMENTED. also yep
  • groupLatch β€” TODO: NOT YET DOCUMENTED. and that's the whole roster, all nine of them, every single one a beautiful blank canvas πŸ¦‹
not me reading nine consecutive "TODO: NOT YET DOCUMENTED" lines and just accepting it as a lifestyle. the upstream maintainers are the main characters here and they said "later" and meant it πŸ™ˆ

πŸ’€ DESCRIPTION πŸ’€

Yeah. There isn't one. That's not a bit, that's just the page. The DESCRIPTION section exists in name only β€” a gorgeous empty room with amazing lighting and absolutely no furniture. vibe check: passed, content: none. ✨


πŸ‘‘ RETURN VALUE πŸ‘‘

You get back an xcb_void_cookie_t. periodt.

Errors β€” if there even are any β€” have to be handled in the event loop. You do not get to just catch them inline, bestie, that's not how this cookie crumbles.

But wait, there's a plot twist: if you'd rather handle errors directly with xcb_request_check, then use xcb_xkb_latch_lock_state_checked instead. Two flavors, pick your fighter. See xcb-requests(3) for all the deets on how that works, iykyk.


πŸ”₯ ERRORS πŸ”₯

This request does never generate any errors.

That's it. That's the whole section. She's chill. She causes zero problems. the peacekeeper of the XCB family πŸ•ŠοΈ no cap.


🌈 SEE ALSO 🌈

(There's nothing here either! The SEE ALSO section is empty. No cross-references, no friends, no little siblings. She's on her own journey and honestly, respect. 🧚)


πŸ’œ AUTHOR πŸ’œ

Generated from xkb.xml. If something's wrong or you've got corrections and improvements, contact xcb@lists.freedesktop.org β€” they're the ones who can actually fix it, not me, I'm just the messenger with good taste πŸ“


okay that's the whole page bestie, we made it to the end πŸ’– this one came to you from X Version 11, libxcb 1.17.0 β€” go forth and latch responsibly, mwah πŸ’…βœ¨πŸ¦‹