XQueryTree (3)

Leading comments

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the foll...

(The comments found at the beginning of the groff file "man3/XQueryTree.3".)

NAME

XQueryTree - query window tree information

SYNTAX

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

ARGUMENTS

children_return

Returns the list of children.

display

Specifies the connection to the X server.

nchildren_return

Returns the number of children.

parent_return

Returns the parent window.

root_return

Returns the root window.

w

Specifies 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 (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). 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 XFree.

XQueryTree can generate a BadWindow error.

BUGS

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

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