XQueryTree(3)

💖 NAME 💖

XQueryTree — query window tree information. She's the main character of XQueryTree(3), and she lives under the XLIB FUNCTIONS umbrella, iykyk 🫶✨

🎀 SYNTAX 🎀

Status XQueryTree(Display *display, Window w, Window *root_return,
       Window *parent_return, Window **children_return, unsigned int
       *nchildren_return);

🦋 ARGUMENTS 🦋

• children_return — this is where the list of children comes back to you, bestie. Literally the child list output. 💖
• display — specifies the connection to the X server. Your link to the X server, periodt.
• nchildren_return — returns the number of children. The count, the total, the “how many are we talking” value.
• parent_return — returns the parent window. Your window's parent, delivered right here. 👑
• root_return — returns the root window. The root window ID, slaying in its output slot.
• w — specifies the window whose list of children, root, parent, and number of children you want to obtain. So yes, this is the window you're doing the whole tree-info vibe check on. 🌸

🌈 DESCRIPTION 🌈

Okay so the XQueryTree function returns the root ID, the parent window ID, a pointer to the list of children windows (NULL when there are no children), and the number of children in the list for the specified window. No cap, all of that comes back together. ✨

The children are listed in current stacking order, from bottom-most (first) to top-most (last). So first = bottom of the stack, last = top of the stack. That's the order, bestie, don't rearrange it. 🦋

XQueryTree returns zero if it fails and nonzero if it succeeds. Simple vibe check: zero = nope, nonzero = yep. 💅

To free a non-NULL children list when it is no longer needed, use XFree. Clean up after yourself, iconic behavior only. 🎀

XQueryTree can generate a BadWindow error.

💀 BUGS 💀

The bug note is literally: This really should return a screen *, not a root window ID. And honestly? Valid. 😭

💅 DIAGNOSTICS 💅

• BadWindow — A value for a Window argument does not name a defined Window.

⭐ SEE ALSO ⭐

• XFree(3)
• XGetWindowAttributes(3)
• XQueryPointer(3)
• Xlib - C Language X Interface

---

mwah 💜 sign-off time: this page is source X Version 11, version libX11 1.8.14, and the date? Not listed on this footer, bestie — no invented numbers, no fake date, just the facts with a bow on top 🎀✨