Product Documentation
Virtuoso Visualization and Analysis XL SKILL Reference
Product Version IC23.1, November 2023

awvSetUpdateStatus

awvSetUpdateStatus(
w_windowID
g_enable
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Sets the update status of a subwindow in the specified Waveform window.

Arguments

w_windowID

Waveform window ID.

g_enable

Specifies whether to turn on the update status of a subwindow.

Valid values are:

  • t: Turns on the update status of a subwindow.
  • nil: Turns off the update status of a subwindow.

A lock icon is displayed in the top-left corner of the subwindow whose update status is turned off.

?subwindow x_subwindow

Identification number of the subwindow, which is found in the top-right corner of the subwindow.

If you do not specify this argument, the specified update status is set for the current subwindow.

Value Returned

t

Update status of the subwindow is set successfully.

nil

The specified Waveform window or subwindow does not exist.

Examples

The following example turns on the update status of subwindow 1 in the current Waveform window.

awvSetUpdateStatus(awvGetCurrentWindow() t ?subwindow 1)
=> t

The following example turns off the update status of subwindow 2 in the current Waveform window.

awvSetUpdateStatus(awvGetCurrentWindow() nil ?subwindow 2)
=> t

Return to top
 ⠀
X