awvGetSubwindowList

awvGetSubwindowList(
w_windowID
[ ?all g_all ]
)
=> l_subwindows / nil

Description

Returns a list of subwindows whose update statuses are turned on.

To return a list of all subwindows, including those whose updates statuses are turned off, set the ?all argument to t.

Arguments

w_windowID	Waveform window ID.
?all g_all	Specifies whether the function returns a list of all subwindows of the specified Waveform window. Valid values are: t: The functions returns a list of all subwindows of the Waveform window. nil: The function returns a list of only those subwindows whose update statuses are turned on. This is the default value.

Value Returned

l_subwindows	A list of subwindows in the specified Waveform window.
nil	The specified Waveform window does not exist.

Examples

The following example returns a list of all subwindows of the current Waveform window. The list also includes the subwindows whose update statuses are turned off.

win = awvGetCurrentWindow()

=> window:5

awvGetSubwindowList(win ?all t)

=> (1 2 3 4)

The following example returns a list of only those subwindows whose update statuses are turned on.

win = awvGetCurrentWindow()

=> window:6

awvGetSubwindowList(win ?all nil)

=> (2 3)

Return to top