awvGetDisplayMode

awvGetDisplayMode(
w_windowID
[ ?subwindow x_subwindow ]
)
=> t_mode / nil

Description

Returns display mode of a subwindow of the specified Waveform window.

Arguments

w_windowID	Waveform window ID.
?subwindow x_subwindow
	Identification number of the subwindow (found in the top-right corner of the subwindow) whose display mode is to be returned. If you do not specify this argument, display mode of the current subwindow is returned.

Value Returned

t_mode	Display mode of the subwindow. Valid values are: composite smith strip
nil	The specified Waveform window or subwindow does not exist.

Examples

The following example returns display mode of the subwindow 2 of the current Waveform window.

win = awvGetCurrentWindow()

=> window:8

awvGetDisplayMode(win ?subwindow 2)

=> "smith"

The following example returns display mode of the current subwindow of the specified Waveform window.

awvGetDisplayMode(window(9))

=> "composite"

Return to top