awvGetOnSubwindowList

awvGetOnSubwindowList(
w_windowID
[ ?all g_all ]
)
=> l_onSubwindows / nil

Description

Returns a list of subwindows that are being used in the specified Waveform window.

This list includes only those subwindows whose display and update statuses are turned on. To get a list of all subwindows whose display statuses are on, regardless of their update statuses, set ?all to t.

Arguments

w_windowID

Waveform window ID.

?all g_all

Specifies whether the function returns a list of all subwindows whose display statuses are on, regardless of their update statuses. Valid values are: t: The functions returns a list of all subwindows whose display statuses are on, regardless of their update statuses. nil: The function returns a list of only those subwindows whose update and display statuses are turned on. This is the default value.

Value Returned

l_subwindows	A list of subwindows whose display statuses are on.
nil	The specified Waveform window does not exist.

Examples

The following example returns a list of subwindows whose update and display statuses are turned on in the Waveform window 4.

awvGetOnSubwindowList(window(4))

=> (1 2 3 4)

The following example turns off the update status of subwindow 2 in the Waveform window 4.

awvSetUpdateStatus(window(4) nil ?subwindow 2)

=> t

The following example turns off the update status of subwindow 4 in the Waveform window 4.

awvSetUpdateStatus(window(4) nil ?subwindow 4)

=> t

The following example turns off the display status of subwindow 2 in the Waveform window 4.

awvSetDisplayStatus(window(4) nil ?subwindow 2)

=> t

The following example returns only subwindows 1 and 3 because only they have both their update and display statuses on.

awvGetOnSubwindowList(window(4))

=> (1 3)

The following example returns subwindows 1, 3, and 4 because they have their display statuses on, regardless of their update statuses.

awvGetOnSubwindowList(window(43) ?all t)

=> (1 3 4)

Return to top