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

πŸŽ€ xcb_x_print_print_get_page_dimensions β€” a whole manual page, bestie edition πŸŽ€

okay so. this is a page from the XCB Requests manual set, and the function we're obsessing over today is xcb_x_print_print_get_page_dimensions from libxcb. it's giving "X Print, but make it page dimensions". let's get into it πŸ’…


✨ NAME ✨

xcb_x_print_print_get_page_dimensions β€” that's literally it, the original leaves the description blank, so we're matching energy


🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include <xcb/xprint.h>

πŸ’– Request function πŸ’–

xcb_x_print_print_get_page_dimensions_cookie_t
       xcb_x_print_print_get_page_dimensions(xcb_connection_t *conn,
       xcb_x_print_pcontext_t context);

πŸ¦‹ Reply datastructure πŸ¦‹

okay so this is the struct you get back, and yes every single field is staying exactly where it is, no cap:

typedef struct xcb_x_print_print_get_page_dimensions_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t width;
    uint16_t height;
    uint16_t offset_x;
    uint16_t offset_y;
    uint16_t reproducible_width;
    uint16_t reproducible_height;
} xcb_x_print_print_get_page_dimensions_reply_t;

⭐ Reply function ⭐

xcb_x_print_print_get_page_dimensions_reply_t
       *xcb_x_print_print_get_page_dimensions_reply(xcb_connection_t *conn,
       xcb_x_print_print_get_page_dimensions_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ’œ REQUEST ARGUMENTS πŸ’œ

  • conn β€” the XCB connection to X11. your little red string to the server, iykyk.
  • context β€” TODO: NOT YET DOCUMENTED. not me leaving it exactly as upstream did 😭

🌈 REPLY FIELDS 🌈

  • response_type β€” the type of this reply, and in this case it's XCB_X_PRINT_PRINT_GET_PAGE_DIMENSIONS. 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 which" energy fr fr.
  • sequence β€” the sequence number of the last request processed by the X11 server.
  • length β€” the length of the reply, in words. and a word is 4 bytes, bestie, don't forget.
  • width β€” TODO: NOT YET DOCUMENTED.
  • height β€” TODO: NOT YET DOCUMENTED.
  • offset_x β€” TODO: NOT YET DOCUMENTED.
  • offset_y β€” TODO: NOT YET DOCUMENTED.
  • reproducible_width β€” TODO: NOT YET DOCUMENTED.
  • reproducible_height β€” TODO: NOT YET DOCUMENTED.

(yeah the TODO squad is out in full force here. that's what the original says, so that's what you get 🫢)


🧚 DESCRIPTION 🧚

the original page literally has nothing under DESCRIPTION. a blank. an empty vibe. so there's nothing for me to spill here β€” the section exists, and it is stunningly silent ✨


πŸ‘‘ RETURN VALUE πŸ‘‘

Returns an xcb_x_print_print_get_page_dimensions_cookie_t. that's the cookie πŸͺ β€” the real tea comes later.

Errors have to be handled when you call the reply function, xcb_x_print_print_get_page_dimensions_reply.

If you'd rather handle your errors in the event loop instead, use xcb_x_print_print_get_page_dimensions_unchecked. see xcb-requests(3) for the deets.


πŸ’€ ERRORS πŸ’€

This request does never generate any errors.

iconic behaviour honestly. zero drama. she simply does not miss.


πŸ”₯ SEE ALSO πŸ”₯

the original page lists nothing here. not a single reference. a whole void. respect. πŸ•³οΈ


πŸ“ AUTHOR πŸ“

Generated from xprint.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. they're literally asking for your notes, bestie, go be a main character and email them πŸ’Œ


and that's the whole thing! this came to you from X Version 11 and libxcb 1.17.0 β€” thanks for reading, ily, go print something gorgeous πŸ’–βœ¨πŸŽ€πŸ¦‹