X11R5

NAME

XQueryTree − query window tree information

SYNOPSIS

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

PARAMETERS

children_return
Returns the list of children.

displaySpecifies the connection to the X server. 

nchildren_return
Returns the number of children.

parent_return
Returns the parent window.

root_returnReturns the root window. 

wSpecifies the window whose list of children, root, parent, and number of children you want to obtain. 

DESCRIPTION

The XQueryTree function returns the root ID, the parent window ID, a pointer to the list of children windows, and the number of children in the list for the specified window. The children are listed in current stacking order, from bottommost (first) to topmost (last). XQueryTree returns zero if it fails and nonzero if it succeeds. To free this list when it is no longer needed, use XFree.

BUGS

This really should return a screen ∗, not a root window ID. 

RELATED INFORMATION

XFree(3X11), XGetWindowAttributes(3X11), XQueryPointer(3X11)
X Window System: The Complete Reference, Second Edition, Robert W. Scheifler and James Gettys