schGetEnv

schGetEnv( 
t_variableName 
)
=> g_value

Description

Gets the value of a schematic environment variable.

Along with the schSetEnv function, this function lets you program the values for various options within the schematic editor without using a form. Also, these functions complement the general environment variable mechanism, which lets you preset values at startup using a .cdsenv file.

Arguments

t_variableName

Name of the schematic environment variable whose value you want to get; must be enclosed in quotation marks.

Value Returned

g_value

Current value of the specified variable.

Examples

Returns the value of the maxLabelOffsetUU environment variable.

result = schGetEnv( "maxLabelOffsetUU" )

Related Topics

schSetEnv

Return to top