xcb_screensaver_query_info(3)

💖 xcb_screensaver_query_info 💖

okay bestie, so this one lives in the xcb_screensaver chapter of the XCB Requests manual (that's the manual name right there, mwah) — and it's genuinely one of the cutest little request/reply pairs in the whole library. no cap. let's get into it ✨

---

🌸 NAME 🌸

xcb_screensaver_query_info — the request that asks the X server "hey girl, what's the screensaver up to right now?" and gets a whole struct of tea back 🫖

---

✨ SYNOPSIS ✨

first things first, you gotta include the header:

#include <xcb/screensaver.h>

🎀 Request function 🎀

xcb_screensaver_query_info_cookie_t
       xcb_screensaver_query_info(xcb_connection_t *conn,
       xcb_drawable_t drawable);

🦋 Reply datastructure 🦋

here's the vibe of the reply, like the actual shape of the thing:

typedef struct xcb_screensaver_query_info_reply_t {
    uint8_t      response_type;
    uint8_t      state;
    uint16_t     sequence;
    uint32_t     length;
    xcb_window_t saver_window;
    uint32_t     ms_until_server;
    uint32_t     ms_since_user_input;
    uint32_t     event_mask;
    uint8_t      kind;
    uint8_t      pad0[7];
} xcb_screensaver_query_info_reply_t;

💅 Reply function 💅

and here's how you actually go pick that reply up:

xcb_screensaver_query_info_reply_t
       *xcb_screensaver_query_info_reply(xcb_connection_t *conn,
       xcb_screensaver_query_info_cookie_t cookie,
       xcb_generic_error_t **e);

---

💜 REQUEST ARGUMENTS 💜

• conn — your XCB connection to X11. the whole lifeline, the main character, the group chat you're posting in 🫶
• drawable — TODO: NOT YET DOCUMENTED. yeah bestie, the docs just left it blank. iconic behaviour honestly 😭

---

🌈 REPLY FIELDS 🌈

• response_type — the type of this reply, and in this case it's XCB_SCREENSAVER_QUERY_INFO. this field is also chillin' inside xcb_generic_reply_t, so you can use it to tell your replies apart from each other. it's giving name-tag at a party 🏷️
• sequence — the sequence number of the last request the X11 server processed.
• length — how long this reply is, in words. and a word here is 4 bytes, just so we're clear 📏
• state — TODO: NOT YET DOCUMENTED.
• saver_window — TODO: NOT YET DOCUMENTED.
• ms_until_server — TODO: NOT YET DOCUMENTED.
• ms_since_user_input — TODO: NOT YET DOCUMENTED.
• event_mask — TODO: NOT YET DOCUMENTED.
• kind — TODO: NOT YET DOCUMENTED.

not me listing a whole bunch of fields that the original docs literally describe as TODO: NOT YET DOCUMENTED 😭 i'm keeping them exactly as they are, bestie — the vibes are preserved, the facts are untouched.

---

🌸 DESCRIPTION 🌸

...okay so the original page has this heading and then absolutely nothing under it. an empty section. a void. the silence is loud, fr fr 💀 we respect it though. periodt.

---

⭐ RETURN VALUE ⭐

you get back an xcb_screensaver_query_info_cookie_t. and listen — errors have to be handled when you call the reply function xcb_screensaver_query_info_reply, that's not optional, that's the whole deal.

if you'd rather handle your errors in the event loop instead, then use xcb_screensaver_query_info_unchecked. see xcb-requests(3) for the details, iykyk 👑

---

💀 ERRORS 💀

good news bestie: this request does never generate any errors. zero drama. a peaceful queen 👑

---

🧚 SEE ALSO 🧚

the original page leaves this one empty too — nothing listed, nothing linked, just vibes ✨

---

🍓 AUTHOR 🍓

generated from screensaver.xml. if you've got corrections or improvements, hit up xcb@lists.freedesktop.org 📬

---

X Version 11 🌸 libxcb 1.17.0 🌸 that's the source and version, bestie — and that's a wrap on xcb_screensaver_query_info(3). go forth and query, you absolute icon 💖✨🎀