1. NAME

XQueryTree - query window tree information

2. SYNTAX

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

3. ARGUMENTS

children_return 1i Returns the list of children.

display 1i Specifies the connection to the X server.

nchildren_return 1i Returns the number of children.

parent_return 1i Returns the parent window.

root_return 1i Returns the root window.

w 1i Specifies the window \*(Wi.

4. DESCRIPTION

The .ZN 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. The children are listed in current stacking order, from bottom-most (first) to top-most (last). .ZN XQueryTree returns zero if it fails and nonzero if it succeeds. To free a non-NULL children list when it is no longer needed, use .ZN XFree .

.ZN XQueryTree can generate a .ZN BadWindow error.

5. BUGS

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

6. DIAGNOSTICS

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

7. SEE ALSO