xcb_record_get_context(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_record_get_context β€” the manual page, but make it make sense πŸ’–

okay bestie, gather round 🫢 this is the manual page for xcb_record_get_context(3) β€” it lives in the XCB Requests family, straight outta the X protocol bindings, and it's part of libxcb. Let's get into it.


✨ NAME ✨

xcb_record_get_context β€”

(yeah. that's it. the name section is literally just vibes and a dash. the original said nothing else, so neither do I πŸ’€)


🌸 SYNOPSIS 🌸

First things first, you gotta pull in the header:

#include <xcb/record.h>

πŸŽ€ Request function

xcb_record_get_context_cookie_t
       xcb_record_get_context(xcb_connection_t *conn,
       xcb_record_context_t context);

πŸ¦‹ Reply datastructure

typedef struct xcb_record_get_context_reply_t {
    uint8_t                     response_type;
    uint8_t                     enabled;
    uint16_t                    sequence;
    uint32_t                    length;
    xcb_record_element_header_t element_header;
    uint8_t                     pad0[3];
    uint32_t                    num_intercepted_clients;
    uint8_t                     pad1[16];
} xcb_record_get_context_reply_t;

πŸ’… Reply function

xcb_record_get_context_reply_t
       *xcb_record_get_context_reply(xcb_connection_t *conn,
       xcb_record_get_context_cookie_t cookie, xcb_generic_error_t **e);

🧚 Reply accessors

int xcb_record_get_context_intercepted_clients_length(const
       xcb_record_get_context_reply_t *reply);
xcb_record_client_info_iterator_t
       xcb_record_get_context_intercepted_clients_iterator(const
       xcb_record_get_context_reply_t *reply);

πŸ‘‘ REQUEST ARGUMENTS πŸ‘‘

  • conn β€” bestie. the plug. the connection to X11. your link to the server, no cap.
  • context β€” TODO: NOT YET DOCUMENTED. (the original really said "we'll figure it out later" and honestly? relatable πŸ™ˆ)

🌈 REPLY FIELDS 🌈

  • response_type β€” tells you what kind of reply this is. in this case it's XCB_RECORD_GET_CONTEXT. this field is also chillin' inside 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 that got processed by the X11 server. it's giving receipts 🧾
  • length β€” how long the reply is, in words. and btw a word is 4 bytes, that's the lore.
  • enabled β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • element_header β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • num_intercepted_clients β€” TODO: NOT YET DOCUMENTED. πŸ’€

πŸ’œ DESCRIPTION πŸ’œ

okay so. this section is completely empty in the original. nothing. void. silent. the manual page simply did not elaborate and I refuse to make things up, so: it's blank, bestie. that's the whole description. iconic honestly πŸ’…


⭐ RETURN VALUE ⭐

It hands you back an xcb_record_get_context_cookie_t. note the cookie β€” that's the "I ordered something, come back for it later" token πŸͺ

Errors? Those don't show up here. You have to deal with them when you call the reply function, xcb_record_get_context_reply.

And if you'd rather catch your errors in the event loop instead? Then use xcb_record_get_context_unchecked instead. Peep xcb-requests(3) for the deets.


πŸ”₯ ERRORS πŸ”₯

This request does never generate any errors. zero. none. clean slate. no drama, no mess. periodt.

🫢 SEE ALSO 🫢

(empty in the original β€” no cross references, no links, just quiet. so we move on πŸ’–)


🌸 AUTHOR 🌸

Generated from record.xml. For corrections and improvements, hit up xcb@lists.freedesktop.org. be nice, they're doing their best πŸ₯Ί


and that's the page, bestie πŸ’– stay slay, handle your cookies, and remember: no errors ever. periodt ✨

X Version 11 Β· libxcb 1.17.0 Β· xcb_record_get_context(3) β€” mwah, love u, go read xcb-requests(3) πŸŒˆπŸŽ€