awvDeleteWaveform

awvDeleteWaveform(
w_windowID
x_index
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Deletes the specified waveform from a subwindow of the specified Waveform window.

Arguments

w_windowID	Waveform window ID.
x_index	ID of the waveform to be deleted. It is an integer value.
x_subwindow	Identification number of the subwindow (found in the top-right corner of the subwindow) from which the specified waveform is to be deleted. If you do not specify this argument, the specified waveform, if exists, is deleted from the current subwindow.

Value Returned

t	Waveform is deleted from the subwindow.
nil	Waveform cannot be deleted because the specified Waveform window, subwindow, or the waveform ID does not exist.

Examples

The following example deletes the waveform with the ID 5 from the subwindow 3 of the current Waveform window.

win = awvGetCurrentWindow()

=> window:4

awvDeleteWaveform(win 5 ?subwindow 3)

=> t

The following example deletes the waveform with the ID 8 from the current subwindow of the specified Waveform window.

awvDeleteWaveform(window(89) 8)

=> t

Return to top