xcb_sync_change_alarm(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_sync_change_alarm ✨

okay bestie, so this one is from the XCB Requests part of the family — it's xcb_sync_change_alarm, a manual page from libxcb. Yes the NAME section in the original is literally just the function name and then nothing, because sometimes the manpage authors leave us on read. 🙈 We still love her.

🌸 SYNOPSIS 🌸

first, you gotta pull in the header:

#include <xcb/sync.h>

🎀 Request function

xcb_void_cookie_t xcb_sync_change_alarm(xcb_connection_t *conn,
       xcb_sync_alarm_t id, uint32_t value_mask, const
       void *value_list);

she returns a xcb_void_cookie_t, so like — she's not handing you data back directly, she's handing you a receipt. 🧾

🦋 REQUEST ARGUMENTS 🦋

  • conn — the XCB connection to X11. your whole lil portal to the X server, iconic.
  • id — TODO: NOT YET DOCUMENTED. 💀 yeah. the docs said "we'll get to it" and then did not get to it.
  • value_mask — TODO: NOT YET DOCUMENTED. also left blank. the audacity.
  • value_list — TODO: NOT YET DOCUMENTED. same energy, bestie. all three of these are still waiting for their moment.
no cap: the original manpage genuinely leaves id, value_mask and value_list undocumented. i'm not gatekeeping anything from you — there is nothing there to gatekeep. 😭

🌈 DESCRIPTION 🌈

the DESCRIPTION section is empty in the original. nothing. void. xcb_void_cookie_t vibes, honestly — it's giving she said nothing and left. 🫶

💅 RETURN VALUE 💅

she gives you back an xcb_void_cookie_t. any errors (if there even are any) have to be handled over in the event loop, not right here.

if you'd rather deal with errors directly using xcb_request_check instead, then use xcb_sync_change_alarm_checked — that's the checked twin. 🌟 see xcb-requests(3) for the full tea on how requests work.

🔥 ERRORS 🔥

this request does never generate any errors. not one. zero. a clean queen. 👑

⭐ SEE ALSO ⭐

the SEE ALSO section is empty in the original — no cross-references listed. she stands alone. main character energy fr fr.

👑 AUTHOR 👑

generated from sync.xml. for corrections and improvements, contact xcb@lists.freedesktop.org — they're the ones you @ when something's off. 💌

and that's the whole page, bestie!! this one came to you from X Version 11, libxcb 1.17.0, under the name xcb_sync_change_alarm(3) — go forth and change those alarms, or at least change the ones whose arguments got documented. mwah 💖✨

📦 where this page comes from