awvResetWindow

awvResetWindow(
w_windowID
[ ?force g_force ]
)
=> t / nil

Description

Resets the specified Waveform window to the state of a new window.

Contents of the specified window are erased and subwindows whose update statuses are turned on are deleted. To delete all subwindows, regardless of their update statuses, set the ?force argument to t.

The Waveform window remains at their current sizes and locations.

Arguments

w_windowID	Waveform window ID.
?force g_force	Specifies whether to delete all subwindows or only those subwindows whose update statuses are turned on. Valid values are: t: All subwindows are deleted regardless of their update statuses. nil: Only those subwindows whose update statuses are turned on are deleted. The default value is nil.

Value Returned

t	The specified Waveform window is reset successfully.
nil	The specified Waveform window does not exist.

Examples

The following example returns IDs of the Waveform windows that are currently open.

awvGetWindowList()

=> (window:3 window:4)

The following example resets the specified Waveform window and deletes only those subwindows whose update statuses are turned on.

awvResetWindow(window(4))

=> t

The following example resets the specified Waveform window and deletes all subwindows, regardless of their update statuses.

awvResetWindow(window(4) ?force t)

=> t

Return to top