ChildWindowList

Description:

baChildWindowList returns a list of a window's child windows.

Platforms:

Windows

Usage:

Result = baChildWindowList( ParentWnd, Class, Caption, MatchCaption )

Arguments:

Integer, string, string, integer.
ParentWnd is the window to get the children of.
Class is the class of child windows to include.
Caption is the window title of child windows to include.
If MatchCaption is true, then Caption must match the window caption exactly (apart from case). If it is false, then any window which contains Caption will be returned. If Caption is an empty string, then MatchCaption is ignored.
The function can use either or both Class and Caption arguments. If one of the arguments is empty, then only the other argument will be used in searching for the windows.

Returns:

List.
Returns a list or string of all found window handles.

Examples:

Director:
wndList = baChildWindowList( 1234, "", "", 0 ) -- return list of all child windows of window 1234

Authorware:
wndList := baChildWindowList( 1234, "Edit", "", 0 ) -- return list of all edit controls of window 1234
 

Notes:

This function will return all child windows of the parent window and all its' children.
 

See also:

baFindWindow
baWindowList
baGetWindow