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

awvGetUnusedEntityList

awvGetUnusedEntityList(
w_windowID
[ ?subwindow x_subwindow ]
[ ?total x_total ]
)
=> l_waveformIndexes / nil

Description

Returns a list of integers that have not already been used to identify waveforms in a subwindow.

You can specify the total number of unused waveform indexes to include in the return value

Arguments

w_windowID

Waveform window ID.

?subwindow x_subwindow

Identification number of the subwindow (found in the top-right corner of the subwindow) in which unused waveform indexes are to be returned.

If you do not specify this argument, the unused waveform indexes in the current subwindow are returned.

?total x_total

Specifies the total number of unused waveform indexes to include in the return value l_waveformIndexes of the function.

Value Returned

l_waveformIndexes

A list of next lowest integers that have not been used to identify existing waveforms in a subwindow of the specified Waveform window.

nil

Indicates an error.

Examples

The following example returns a list of 7 unused waveform indexes that have not been used in subwindow 2 of the current Waveform window.

awvGetUnusedEntityList(awvGetCurrentWindow() ?subwindow 2 ?total 7)
=>
(27 28 29 30 31
    32 33
)

Return to top
 ⠀
X