xcb_dpms_get_timeouts(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_dpms_get_timeouts(3) 🌸

okay bestie, welcome to the XCB Requests corner of the manual, page xcb_dpms_get_timeouts(3) 💖 this one's about asking the X server what your screen's power-saving timeouts are set to. short page, but we're gonna treat it with the respect it deserves. periodt.

✨ NAME ✨

xcb_dpms_get_timeouts — and honestly? that's it. the manpage leaves the description blank, so no cap, the name is doing all the heavy lifting here 🫶

✨ SYNOPSIS ✨

first things first, you gotta bring in the header:

#include <xcb/dpms.h>

🎀 Request function

xcb_dpms_get_timeouts_cookie_t
       xcb_dpms_get_timeouts(xcb_connection_t *conn,
yes the trailing comma is really there. i don't make the rules, i just transcribe them 💅

🎀 Reply datastructure

this is the lil struct you get back, verbatim, no edits, iconic:

typedef struct xcb_dpms_get_timeouts_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t standby_timeout;
    uint16_t suspend_timeout;
    uint16_t off_timeout;
    uint8_t  pad1[18];
} xcb_dpms_get_timeouts_reply_t;

🎀 Reply function

xcb_dpms_get_timeouts_reply_t
       *xcb_dpms_get_timeouts_reply(xcb_connection_t *conn,
       xcb_dpms_get_timeouts_cookie_t cookie, xcb_generic_error_t **e);

✨ REQUEST ARGUMENTS ✨

  • conn — the XCB connection to X11. your lil phone line to the server, basically 📞

✨ REPLY FIELDS ✨

let's unpack this reply like it's a group chat screenshot 🔍

  • response_type — the type of this reply, and in this specific case it's XCB_DPMS_GET_TIMEOUTS. this field is also chillin' inside xcb_generic_reply_t, and you can use it to tell replies apart from each other. it's the name tag at the party 🏷️
  • sequence — the sequence number of the last request processed by the X11 server. keeping track, as she should 💅
  • length — the length of the reply, in words (and a word is 4 bytes, bestie, don't forget).
  • standby_timeout — TODO: NOT YET DOCUMENTED. 😭 we know nothing. it's a mystery. a little enigma. the docs simply did not show up.
  • suspend_timeout — TODO: NOT YET DOCUMENTED. 🙈 same vibe, same void.
  • off_timeout — TODO: NOT YET DOCUMENTED. 💀 three for three, the documentation is on vacation.

✨ DESCRIPTION ✨

...it's empty. that's the whole thing. the description section is giving minimalism, giving silence, giving "we said what we said" 🦋 nothing to add, nothing to summarize — that's literally all the original has, so that's all you get.

✨ RETURN VALUE ✨

you get back an xcb_dpms_get_timeouts_cookie_t 🍪 — yes, a cookie, that's the actual name, we love a themed API.

and listen: errors have to be handled when you call the reply function xcb_dpms_get_timeouts_reply.

but if you'd rather handle errors in the event loop instead? use xcb_dpms_get_timeouts_unchecked 💫 and if you want the whole tea on how that works, go read xcb-requests(3).

✨ ERRORS ✨

this request does never generate any errors. not a single one. zero. flawless. no drama. 👑

✨ SEE ALSO ✨

also empty, bestie. nothing linked, nothing referenced. it's just you and this page. romantic, honestly 🎀

✨ AUTHOR ✨

generated from dpms.xml 📄 and if you spot something wrong or wanna make it better, hit up xcb@lists.freedesktop.org for corrections and improvements 💌

and that's the whole page, bestie!! 💖✨ this was X Version 11, libxcb 1.17.0, and we read it together like the little Unix girlies we are 🧚‍♀️ slay, bye 👋🎀

📦 where this page comes from