xcb_xc_misc_get_xid_list(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_xc_misc_get_xid_list β€” the XCB requests manual πŸ’«

okay bestie, welcome to the xcb_xc_misc_get_xid_list page from the XCB Requests fam πŸ’– this is the libxcb 1.17.0 era, X Version 11 vibes, and we're gonna walk through it together, no cap.


🌸 NAME 🌸

xcb_xc_misc_get_xid_list β€” (yes the description is literally blank in the original, iconic minimalism, she said nothing and left πŸ’…)


✨ SYNOPSIS ✨

First things first, you gotta pull in the header:

#include <xcb/xc_misc.h>

πŸŽ€ Request function πŸŽ€

xcb_xc_misc_get_xid_list_cookie_t
       xcb_xc_misc_get_xid_list(xcb_connection_t *conn, uint32_t count);

πŸ¦‹ Reply datastructure πŸ¦‹

this is the lil struct she hands back, look at her:

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

🌈 Reply function 🌈

xcb_xc_misc_get_xid_list_reply_t
       *xcb_xc_misc_get_xid_list_reply(xcb_connection_t *conn,
       xcb_xc_misc_get_xid_list_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ“ Reply accessors πŸ“

the lil helper besties that go digging inside the reply for you:

uint32_t *xcb_xc_misc_get_xid_list_ids(const
       xcb_xc_misc_get_xid_list_request_t *reply);

int xcb_xc_misc_get_xid_list_ids_length(const
       xcb_xc_misc_get_xid_list_reply_t *reply);

xcb_generic_iterator_t xcb_xc_misc_get_xid_list_ids_end(const
       xcb_xc_misc_get_xid_list_reply_t *reply);

πŸ’œ REQUEST ARGUMENTS πŸ’œ

  • conn β€” your XCB connection to X11. the whole reason you're here fr fr.
  • count β€” TODO: NOT YET DOCUMENTED. yeah babe, the docs said "we'll get to it" and then never did 😭 not me exposing the maintainers.

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, which in this case is XCB_XC_MISC_GET_XID_LIST. this field is also chillin' in the xcb_generic_reply_t, and it's literally how you tell your replies apart from each other. main character identifier energy.
  • sequence β€” the sequence number of the last request processed by the X11 server. very "where were we" of her.
  • length β€” the length of the reply, in words. and a word is 4 bytes, so don't come at me with letters, this is the technical kind of word πŸ’€
  • ids_len β€” TODO: NOT YET DOCUMENTED. again!! the mystery continues πŸ™ˆ

🌟 DESCRIPTION 🌟

nothing here bestie. the original page just… leaves it blank. we move. πŸ’…

🫢 RETURN VALUE 🫢

She hands you back an xcb_xc_misc_get_xid_list_cookie_t. Errors? You don't deal with them right here β€” you handle them when you call the reply function xcb_xc_misc_get_xid_list_reply.

If you'd rather catch errors in the event loop instead, use xcb_xc_misc_get_xid_list_unchecked. Peep xcb-requests(3) for the full tea.


πŸ’€ ERRORS πŸ’€

This request does never generate any errors. not one. zero. she's a good girl, she causes no drama, periodt. ✨


🌈 SEE ALSO 🌈

(also blank in the original β€” the vibe is "you already know" 😌)

⭐ AUTHOR ⭐

Generated from xc_misc.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. so if something's off, that's the group chat to slide into 🫢


and that's the whole page, bestie!! mwah πŸ’– this was the xcb_xc_misc_get_xid_list(3) manual from X Version 11, shipped with libxcb 1.17.0 β€” go forth and query those XIDs like the icon you are πŸ‘‘βœ¨