xcb_get_screen_saver(3)

💖 xcb_get_screen_saver — a manual page, but make it cute 💖

okay bestie, welcome to xcb_get_screen_saver, straight out of the XCB Requests section of the manual (yes, that's the manual name, we're not being weird about it, it's just the category, okay?). This is the little request that asks the X11 server "hey girlie, what's up with the screen saver rn?" 🌸

---

✨ NAME ✨

xcb_get_screen_saver — and that's literally it. The original page has no summary line at all after the dash, bestie. Nothing. Blank. It's giving mysterious. 🙈 We're not making anything up to fill the void, we're just reporting the vibes accurately.

---

🌈 SYNOPSIS 🌈

First things first, you gotta pull in the header:

#include <xcb/xproto.h>

🎀 Request function 🎀

xcb_get_screen_saver_cookie_t
       xcb_get_screen_saver(xcb_connection_t *conn,

🦋 Reply datastructure 🦋

this is the struct you get back, look at her:

typedef struct xcb_get_screen_saver_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t timeout;
    uint16_t interval;
    uint8_t  prefer_blanking;
    uint8_t  allow_exposures;
    uint8_t  pad1[18];
} xcb_get_screen_saver_reply_t;

💅 Reply function 💅

xcb_get_screen_saver_reply_t
       *xcb_get_screen_saver_reply(xcb_connection_t *conn,
       xcb_get_screen_saver_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 ⭐

• response_type — the type of this reply, and in this case it's XCB_GET_SCREEN_SAVER. this field is also hanging out in xcb_generic_reply_t, and you can use it to tell replies apart from each other, like name tags at a party. 🎀
• sequence — the sequence number of the last request processed by the X11 server.
• length — the length of the reply, in words. and reminder bestie, a word is 4 bytes. periodt.
• timeout — TODO: NOT YET DOCUMENTED. yeah. that's what it says. we don't know either. 😭
• interval — TODO: NOT YET DOCUMENTED. same energy. 💀
• prefer_blanking — one of the following values, bestie:
  • XCB_BLANKING_NOT_PREFERRED — TODO: NOT YET DOCUMENTED.
  • XCB_BLANKING_PREFERRED — TODO: NOT YET DOCUMENTED.
  • XCB_BLANKING_DEFAULT — TODO: NOT YET DOCUMENTED.

and then, just chillin' underneath the whole list, on its own: TODO: NOT YET DOCUMENTED. 🫠 yeah, the original does that. we're preserving it. no notes.

• allow_exposures — one of the following values:
  • XCB_EXPOSURES_NOT_ALLOWED — TODO: NOT YET DOCUMENTED.
  • XCB_EXPOSURES_ALLOWED — TODO: NOT YET DOCUMENTED.
  • XCB_EXPOSURES_DEFAULT — TODO: NOT YET DOCUMENTED.

and yep, one more lonely TODO: NOT YET DOCUMENTED. hanging out at the bottom of the list too. iconic behaviour honestly. 🙈

---

💜 DESCRIPTION 💜

so… the DESCRIPTION section is empty. completely. the original page has literally nothing under it. not a word. it's giving silent treatment. we are NOT inventing lore. 💀

---

🔥 RETURN VALUE 🔥

Returns an xcb_get_screen_saver_cookie_t. 🍪

Errors? bestie, those have to be handled when you call the reply function xcb_get_screen_saver_reply.

If you'd rather handle errors in the event loop instead, use xcb_get_screen_saver_unchecked. See xcb-requests(3) for the deets. 🫶

---

👑 ERRORS 👑

This request does never generate any errors. not a single one. she's perfect, she's unproblematic, she simply does not start drama. ✨

---

🌸 SEE ALSO 🌸

nothing here. the original lists zero cross-references. empty. blank. a void. we respect the void. 🕳️

---

💖 AUTHOR 💖

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

---

and that's the whole page, bestie!! go forth and query your screen saver, you absolute main character. 💅🌈⭐

this was brought to you by the folks at X Version 11, running libxcb 1.17.0, and the page itself is dated xcb_get_screen_saver(3). mwah. 🎀