xcb_list_properties(3)

💖 xcb_list_properties — bestie edition 💖

okay so. this is a page from section 3 of the manual, it's called xcb_list_properties, and it lives in the XCB family of requests (XCB Requests, if we're being formal, which we are not). it's the request that asks the X11 server "hey girl, what properties does this window have?" and it's about to be your new obsession. no cap.

---

🌸 NAME 🌸

xcb_list_properties -

and that's it. that's the whole NAME section. it's giving minimalism. it's giving "i woke up and chose silence." we move. 💅

---

✨ SYNOPSIS ✨

first things first, you gotta bring in the header:

#include <xcb/xproto.h>

🦋 Request function 🦋

this is the one that kicks it all off:

xcb_list_properties_cookie_t xcb_list_properties(xcb_connection_t *conn,
       xcb_window_t window);

🎀 Reply datastructure 🎀

and this is the little struct that comes back at you:

typedef struct xcb_list_properties_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t atoms_len;
    uint8_t  pad1[22];
} xcb_list_properties_reply_t;

🌈 Reply function 🌈

grab your actual reply with this:

xcb_list_properties_reply_t
       *xcb_list_properties_reply(xcb_connection_t *conn,
       xcb_list_properties_cookie_t cookie, xcb_generic_error_t **e);

🫶 Reply accessors 🫶

and these three are the little helpers that dig the atoms out of the reply for you:

xcb_atom_t *xcb_list_properties_atoms(const
       xcb_list_properties_request_t *reply);

int xcb_list_properties_atoms_length(const xcb_list_properties_reply_t
       *reply);

xcb_generic_iterator_t xcb_list_properties_atoms_end(const
       xcb_list_properties_reply_t *reply);

---

👑 REQUEST ARGUMENTS 👑

• conn — your XCB connection to X11, aka your direct line to the server. 💜
• window — TODO: NOT YET DOCUMENTED. yeah bestie, that's literally what it says. the docs simply did not show up to the function. we're all just out here living our truth. 😭

---

💀 REPLY FIELDS 💀

• response_type — the type of this reply, and in this case it's XCB_LIST_PROPERTIES. plot twist: this field is also hanging out in the xcb_generic_reply_t, so you can use it to tell replies apart from each other. very "same energy, different font." 🔥
• sequence — the sequence number of the last request the X11 server processed. it's the receipt number of the server world. 🧾
• length — how long the reply is, in words. and bestie, a word here is 4 bytes. don't forget it, i'm not repeating myself (i will absolutely repeat myself). ✨
• atoms_len — TODO: NOT YET DOCUMENTED. again. the mystery continues. 🙈

---

🍓 DESCRIPTION 🍓

...it's empty. there is no description. the description section is a blank canvas and honestly? main character energy. we respect the privacy of the description. 🎀

---

⭐ RETURN VALUE ⭐

it hands you back an xcb_list_properties_cookie_t. cute little cookie. 🍪

but listen — errors have to be handled when you call the reply function xcb_list_properties_reply. that's the moment of truth.

and if you'd rather handle your errors in the event loop instead, use xcb_list_properties_unchecked. if you want the full tea on how that works, go read xcb-requests(3) for details. iykyk. 💅

---

🚨 ERRORS 🚨

this request does never generate any errors. never ever. zero. none. a perfect flawless angel request with no drama whatsoever. slay. 💖

---

🌟 SEE ALSO 🌟

(empty. nothing to see here. literally. the SEE ALSO section said "and that's on periodt" and left. 🌸)

---

🧚 AUTHOR 🧚

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

---

and that's the whole page, bestie. you ate. 💅✨

this little gem ships with X Version 11, libxcb 1.17.0, and it answers to the name xcb_list_properties(3). go forth and list those properties. 🦋🌈💜