awvClearWindowHistory

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

Description

Erases the contents of the specified Waveform window.

This function deletes the waveforms, title, date stamp, and labels stored in the internal memory. By default, this function operates only on the subwindows whose update statuses are turned on.

Arguments

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

Value Returned

t	Contents of the Waveform window are erased.
nil	Contents of the Waveform window cannot be erased because the specified Waveform window does not exist.

Examples

The following example erases contents from all subwindows of the current Waveform window.

win = awvGetCurrentWindow()

=> window:4

awvClearWindowHistory(win ?force t)

=> t

The following example erases contents only from the subwindows whose update statuses are turned on in the current Waveform window.

win = awvGetCurrentWindow()

=> window:4

awvClearWindowHistory(win)

=> t

Return to top