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

envGetDefVal

envGetDefVal(
t_tool[.Partition]
t_varName
[ s_varType ]
) 
=> g_data

Description

Retrieves the registered default value for a variable. The tool is faulted in if it is not already faulted in, where faulting in is the process of reading the .cdsenv file and initializing the variables.

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.

s_varType

The type of the variable. Possible choices are ’int, ’float, ’string, ’boolean, ’cyclic or ’toggle.

Values Returned

g_data

The value of the variable. The following types are returned for the following data types:

Data Type

Returned Value Type

int

int

float

float

string

string

boolean

t | nil

cyclic

string

toggle

list of t | nil

Related Topics

Cdsenv Editor Functions


Return to top
 ⠀
X