xcb_force_screen_saver(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_force_screen_saver 💖

okay bestie, welcome to the xcb_force_screen_saver page — it lives in section 3 of the manual, so it's a library function, not a command you type in your shell. no cap.

✨ NAME ✨

xcb_force_screen_saver — (the original literally leaves the description blank, so… that's the whole vibe, iykyk 🫶)

🌸 SYNOPSIS 🌸

#include <xcb/xproto.h>

🎀 Request function 🎀

xcb_void_cookie_t xcb_force_screen_saver(xcb_connection_t *conn,
       uint8_t mode);

🦋 REQUEST ARGUMENTS 🦋

  • conn — the XCB connection to X11. she's your link to the server, your main character connector, the whole point 💅
  • mode — literally one of these two values, bestie:
    • XCB_SCREEN_SAVER_RESET — TODO: NOT YET DOCUMENTED. 😭 not me finding out the docs never got written
    • XCB_SCREEN_SAVER_ACTIVE — TODO: NOT YET DOCUMENTED. and then there's just a stray TODO: NOT YET DOCUMENTED. hanging out right after it, unclaimed, vibing on its own line 🫠
fr fr the upstream docs are giving "incomplete assignment energy" here. the TODOs are verbatim from the original, I'm not making this up 💀

💜 DESCRIPTION 💜

…and that's it. the DESCRIPTION section is empty in the original. iconic of them honestly. nothing to describe, no notes. 🌈

⭐ RETURN VALUE ⭐

she returns an xcb_void_cookie_t — yes, void, so no actual value comes back, just a cookie you can check later. 🍪

Any errors (if there are any) have to be handled in the event loop. that's just how the async girlies do it.

If you want to handle errors directly with xcb_request_check instead, use xcb_force_screen_saver_checked. different function, same energy, but with receipts. 🧾✨

See xcb-requests(3) for the details.

🙈 ERRORS 🙈

this request does never generate any errors. 💀 zero. none. she is unproblematic. periodt.

💀 SEE ALSO 💀

empty in the original — nothing to see, nothing to also. leaving it exactly as iconic as I found it. 💅

👑 AUTHOR 👑

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. 🫶

okay that's the whole page bestie, we ate and left no crumbs 🌸 and just so you have the receipts: this is from X Version 11, libxcb 1.17.0, and the manual page itself is xcb_force_screen_saver(3). mwah 💖✨🎀

📦 where this page comes from