XCB_X_PRINT_PRINT_GET_DOCUMENT_DATA_UNCHECKED(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

✨ NAME ✨

xcb_x_print_print_get_document_data β€” bestie, this is one of those libxcb X Print request pages where the docs literally say nothing else, and I'm not gonna lie to you about that πŸ’…


🌸 SYNOPSIS 🌸

Pull in the header first, always:

#include <xcb/xprint.h>

πŸŽ€ Request function

xcb_x_print_print_get_document_data_cookie_t
       xcb_x_print_print_get_document_data(xcb_connection_t *conn,
       xcb_x_print_pcontext_t context, uint32_t max_bytes);

πŸ¦‹ Reply datastructure

typedef struct xcb_x_print_print_get_document_data_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint32_t status_code;
    uint32_t finished_flag;
    uint32_t dataLen;
    uint8_t  pad1[12];
} xcb_x_print_print_get_document_data_reply_t;

🌈 Reply function

xcb_x_print_print_get_document_data_reply_t
       *xcb_x_print_print_get_document_data_reply(xcb_connection_t *conn,
       xcb_x_print_print_get_document_data_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ’– Reply accessors

uint8_t *xcb_x_print_print_get_document_data_data(const
       xcb_x_print_print_get_document_data_request_t *reply);

int xcb_x_print_print_get_document_data_data_length(const
       xcb_x_print_print_get_document_data_reply_t *reply);

xcb_generic_iterator_t
       xcb_x_print_print_get_document_data_data_end(const
       xcb_x_print_print_get_document_data_reply_t *reply);

πŸ‘‘ REQUEST ARGUMENTS πŸ‘‘

  • conn β€” the XCB connection to X11. Your lil phone line to the server, basically 🫢
  • context β€” TODO: NOT YET DOCUMENTED. yeah. that's it. that's the whole description. iconic of them honestly πŸ’€
  • max_bytes β€” TODO: NOT YET DOCUMENTED. same energy, same silence 😭

πŸ’œ REPLY FIELDS πŸ’œ

  • response_type β€” the type of this reply, and for this one it's XCB_X_PRINT_PRINT_GET_DOCUMENT_DATA. This field also lives in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. Very "which one of y'all is this" energy ✨
  • sequence β€” the sequence number of the last request processed by the X11 server. Receipts, but for the server 🧾
  • length β€” how long the reply is, in words (and a word here is 4 bytes, keep up bestie) πŸ“
  • status_code β€” TODO: NOT YET DOCUMENTED. πŸ™ˆ
  • finished_flag β€” TODO: NOT YET DOCUMENTED. πŸŽ€
  • dataLen β€” TODO: NOT YET DOCUMENTED. lowkey a mystery, highkey still a real field πŸ’…

πŸ’« DESCRIPTION πŸ’«

Okay so... there is genuinely nothing here. The DESCRIPTION section is empty. Not a single word. The void. The silence. We move πŸ¦‹


⭐ RETURN VALUE ⭐

Returns an xcb_x_print_print_get_document_data_cookie_t. Real talk: errors have to be handled when you call the reply function xcb_x_print_print_get_document_data_reply.

If you'd rather handle errors in the event loop instead, use xcb_x_print_print_get_document_data_unchecked. Peep xcb-requests(3) for the details, no cap πŸ“š


πŸ’€ ERRORS πŸ’€

This request does never generate any errors. Not one. Zero. None. She's unproblematic, periodt πŸ‘‘

πŸ”₯ SEE ALSO πŸ”₯

(blank. nothing. an empty shelf. we love a minimalist moment 🌸)


πŸ“ AUTHOR πŸ“

Generated from xprint.xml. Contact xcb@lists.freedesktop.org for corrections and improvements β€” they're literally asking for your notes, bestie, so don't be shy 🫢


X Version 11 Β· libxcb 1.17.0 β€” that's the whole vibe check, the source and the version, and I'm signing off like the main character I am. mwah πŸ’‹βœ¨