Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

envCyclicStringToIndex

envCyclicStringToIndex(
t_tool[.Partition]
t_varName
t_cyclicString
) 
=> x_itemIndex

Description

Returns the index of the string for the given cyclic variable. This order is determined by the order of choices specified in the tool’s registration file. The index is 0-based. -1 is returned for an invalid choice.

Arguments

t_tool[ .Partition]

The name of the tool and the partition (if any). A partition is a way of grouping related sets of variables associated with a tool.

t_varName

The name of the variable

t_cyclicString

The string whose index in the list of choices is desired.

Values Returned

x_itemIndex

Returns 0-based index of this string in the choice list. If the specified string cannot be found among the list of choices, or other error conditions occur, -1 is returned.

Related Topics

Cdsenv Editor Functions


Return to top
 ⠀
X