awvGetSubwindowTitle

awvGetSubwindowTitle(
w_windowID
[ ?subwindow x_subwindow ]
)
=> t_subwindowTitle / nil

Description

Returns the title of a subwindow in 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 title is to be returned. If you do not specify this argument, the title of the current subwindow is returned.

Value Returned

t_subwindowTitle	Title of a subwindow in the specified Waveform window.
nil	The specified Waveform window or subwindow does not exist.

Examples

The following example returns the title of the current subwindow of the current Waveform window.

awvGetSubwindowTitle(awvGetCurrentWindow() ?subwindow awvGetCurrentSubwindow(awvGetCurrentWindow()))

=> "Transient Analysis 'tran': time = (0 s -> 100 ns)"

The following example sets the title of the current subwindow to Transient Response.

awvDisplaySubwindowTitle(awvGetCurrentWindow() "Transient Response" ?subwindow awvGetCurrentSubwindow(awvGetCurrentWindow()))

=> t

The following function now returns the title of the current subwindow that is set using the awvDisplaySubwindowTitle function.

awvGetSubwindowTitle(awvGetCurrentWindow() ?subwindow awvGetCurrentSubwindow(awvGetCurrentWindow()))

=> "Transient Response"

Return to top