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

envCyclicIndexToString

envCyclicIndexToString(
t_tool[.Partition]
t_varName
x_itemIndex
) 
=> t_stringChoice

Description

Returns the string choice associated with a particular index. 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 (application) 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

x_itemIndex

The index for which the string choice is desired. This is a 0-based index.

Values Returned

t_stringChoice

The string whose index is specified in the list of choices. If the specified index is not found among the list of choices, or other error conditions occur, -1 is returned.

Examples

envCyclicIndexToString( "ui" "showMouseBar" 1 ) 
=> "Bottom"

Related Topics

Cdsenv Editor Functions


Return to top
 ⠀
X