xcb_x_print_p..._printer_list(3)

💖 xcb_x_print_p..._printer_list(3) 💖

okay bestie, buckle up — this is a page from XCB Requests, and the whole vibe is X Print, the X11 printing extension. yes, printing. from X11. iconic of her honestly. 🎀

---

✨ NAME ✨

xcb_x_print_print_get_printer_list — and that's it. that's the whole description. the manpage literally left it blank, no cap. we're all just out here vibing with an empty tagline. 🫶

---

🌸 SYNOPSIS 🌸

first things first, you gotta bring in the header:

#include <xcb/xprint.h>

🦋 Request function 🦋

this is the one you actually call to ask for the printer list:

xcb_x_print_print_get_printer_list_cookie_t
       xcb_x_print_print_get_printer_list(xcb_connection_t *conn,
       uint32_t printerNameLen, uint32_t localeLen, const
       xcb_x_print_string8_t *printer_name, const
       xcb_x_print_string8_t *locale);

🦋 Reply datastructure 🦋

here's the lil struct the server sends back, all laid out:

typedef struct xcb_x_print_print_get_printer_list_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint32_t listCount;
    uint8_t  pad1[20];
} xcb_x_print_print_get_printer_list_reply_t;

🦋 Reply function 🦋

and this is how you go pick up that reply, bestie:

xcb_x_print_print_get_printer_list_reply_t
       *xcb_x_print_print_get_printer_list_reply(xcb_connection_t *conn,
       xcb_x_print_print_get_printer_list_cookie_t cookie,
       xcb_generic_error_t **e);

🦋 Reply accessors 🦋

the little helper functions that reach into the reply for you:

int xcb_x_print_print_get_printer_list_printers_length(const
       xcb_x_print_print_get_printer_list_reply_t *reply);

xcb_x_print_printer_iterator_t
       xcb_x_print_print_get_printer_list_printers_iterator(const
       xcb_x_print_print_get_printer_list_reply_t *reply);

---

💅 REQUEST ARGUMENTS 💅

• conn — the XCB connection to X11. your link to the whole server situation, the main character of every XCB call honestly.
• printerNameLen — TODO: NOT YET DOCUMENTED. 😭 nobody wrote it down bestie, we just don't know.
• localeLen — TODO: NOT YET DOCUMENTED. also a mystery. the docs ghosted us fr fr.
• printer_name — TODO: NOT YET DOCUMENTED. 🙈
• locale — TODO: NOT YET DOCUMENTED. four for four, the whole argument list is un-documented and we respect the consistency lowkey.

---

🌈 REPLY FIELDS 🌈

• response_type — the type of this reply, which in this case is XCB_X_PRINT_PRINT_GET_PRINTER_LIST. this same field also lives in the xcb_generic_reply_t, and it's how you tell your replies apart from each other when they're all showing up in your inbox at once. 💌
• sequence — the sequence number of the last request that got processed by the X11 server. it's giving receipt number.
• length — how long the reply is, measured in words. and before you ask: a word is 4 bytes. ✨
• listCount — TODO: NOT YET DOCUMENTED. 💀

---

⭐ DESCRIPTION ⭐

...okay so there is literally nothing here. the DESCRIPTION section is empty. the page said "I'm not gonna explain myself" and moved on. no notes, honestly. 👑

---

🍓 RETURN VALUE 🍓

this function hands you back an xcb_x_print_print_get_printer_list_cookie_t. cookies are the whole XCB thing — you get the cookie now, you cash it in later.

and that means: any errors? you have to deal with them when you call the reply function, xcb_x_print_print_get_printer_list_reply.

if you'd rather handle your errors in the event loop instead, use xcb_x_print_print_get_printer_list_unchecked — it skips the automatic error handling. the deets are in xcb-requests(3) if you want the full lore. 📚

---

😭 ERRORS 😭

good news bestie: this request never generates any errors. not one. zero. it's the chillest request at the function. ✨🦋

---

💜 SEE ALSO 💜

...yeah. this section is empty too. the page is just out here with no friends. we support her anyway. 🫶

---

👑 AUTHOR 👑

Generated from xprint.xml. If you've got corrections or improvements, hit up xcb@lists.freedesktop.org — they'd love to hear from you. 📧

---

and that's the whole page, babe. generated from xprint.xml, straight out of X Version 11, running libxcb 1.17.0 — so if you were wondering which version of this un-documented masterpiece you're reading, it's that one. periodt. 💅✨