xcb_screensaver_suspend(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_screensaver_suspend ✨

okay bestie, welcome to the xcb_screensaver_suspend(3) page — part of the XCB Requests family, living in section 3 of the manual (you know, the "library functions" section, very demure, very coder). pull up a chair 🫶

🌸 NAME 🌸

xcb_screensaver_suspend — and that's literally all the NAME section says, no cap, the description line is just vibes and empty space 💀

🎀 SYNOPSIS 🎀

first things first, you gotta pull in the header:

#include <xcb/screensaver.h>

🦋 Request function 🦋

here's the actual function signature, copy it exactly bestie:

xcb_void_cookie_t xcb_screensaver_suspend(xcb_connection_t *conn,
       uint32_t suspend);

💅 REQUEST ARGUMENTS 💅

  • conn — your XCB connection to X11. it's the lil handshake between you and the X server, the main character of every XCB call fr fr.
  • suspend — TODO: NOT YET DOCUMENTED. i know, i know 😭 the docs really said "figure it out" on this one. not me being held responsible for the mysteries of suspend. it's a uint32_t though, that part we do know.

🧚 DESCRIPTION 🧚

okay so… there is literally nothing here. the DESCRIPTION section is empty. a blank canvas. the void. iconic of it, honestly ✨ no extra lore for you today, bestie.

⭐ RETURN VALUE ⭐

it hands you back an xcb_void_cookie_t. and here's the tea: any errors (if there even are any) have to be handled over in the event loop, so don't come crying to the return value about it 💀

if you'd rather deal with errors directly using xcb_request_check, then you want xcb_screensaver_suspend_checked instead. xcb-requests(3) has the full details if you wanna go deeper 👑

🔥 ERRORS 🔥

good news, bestie: this request does never generate any errors. zero. none. a clean slate. slay 💅✨

🌈 SEE ALSO 🌈

…nothing here either 😭 the SEE ALSO section is as empty as my weekend plans. no cross-references, no friends, just us.

👑 AUTHOR 👑

Generated from screensaver.xml. if you've got corrections or improvements, hit up xcb@lists.freedesktop.org — they're literally waiting for your feedback, bestie 🫶

and that's a wrap on the whole page 💖 this one came to you from X Version 11, with libxcb 1.17.0 holding it down, and the manual page title itself being xcb_screensaver_suspend(3). thanks for reading, stay hydrated, and may your cookies always be void in the good way 🎀🦋🌸✨

📦 where this page comes from