ICSE 2001 Logo   Rigi Logo
 
rcl_env_set
Back to RCL Command Index

Argument Default Description
cfgVariable - Name of configuration variable
cfgValue - String value of configuration variable

Description:

This procedure changes the value of a configuration variable, cfgVariable, to the value supplied in cfgValue. If the variable does not exist, a new variable is created. The variable changes the environment within rigiedit, not within the operating system shell. Variable names and values may be of mixed case with special characters but precautions must be taken to make the special characters transparent to Tcl. For example, if there are embedded blanks, double-quotation marks must surround the string expression.

Rigi sets a number of configuration variables that can be seen and edited using the Options/Setup menu item. Custom variables can be constructed either through this menu item or through the rcl_env_set command.

Unlike other configuration variables, The RIGI variable can be referenced as $RIGI by other variables (see the example below). If the RIGI variable is changed, the values of other referencing variables will likewise be changed. Changes to the values of standard Rigi environment variables, especially the RIGI variable, can result in unpredictable behavior because of potential side-effects.

The cfgValue can be retrieved using rcl_env_get command.

Return Value:

None.

Exceptions:

None.

Example:

# Set a configuration variable, workDir, to point to a
# subdirectory under the Rigi installation directory.
# The $RIGI reference must be preceded by a backslash
# because Tcl treats it as a special character.

rcl_env_set workDir \$RIGI/scratch

# Set a configuration variable, domainDir, to point to
# a specific domain subdirectory, COBOL.

rcl_env_set domainDir [rcl_env_get RIGIINIT]/COBOL

Back to RCL Command Index

.