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

envSetVal

envSetVal(
t_tool[.Partition]
t_varName
s_varType
g_newVal
) 
=> t / nil

Description

Sets an environment variable value in the setup database. 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. If a set trigger function is registered for this variable (see the envRegSetTrigger function), it gets called after the value is set.

You cannot set an environment variable that has not been registered.

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 environment variable.

s_varType

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

g_newVal

The new value for the environment variable.

Values Returned

t

The new value was set.

nil

There was an error and the new value could not be set.

Related Topics

Cdsenv Editor Functions


Return to top
 ⠀
X