Set Environment Variable

Declaration

<AMSETENVIRONMENT NAME="Text" TYPE="Text" VALUE="Text" CREATEIFNOTEXIST="YES/NO" />

See Also

Set Environment Variable Action-Setting Properties

Description

Sets the value of a system or user-level environment variable, and optionally creates the variable if it does not exist.

Practical Usage

Used to set the value of an existing environment variable, or to create a new environment variable with a specified value.

Parameters

General Tab

Environment Variable Name

Text, Required
MARKUP: NAME="TEMP"

Specifies the name of the environment variable to set.

Environment Variable Scope

Text, Optional - Default "User"
MARKUP: TYPE="USER"

Specifies the scope of the environment variable.

Options are:
 

New value

Text, Required
MARKUP: VALUE="C:\Documents and Settings\Users\Temp"

Specifies the new value of the environment variable.

Create Environment Variable Only if it Does Not Exist

Yes/No, Optional - Default "No"
MARKUP: CREATEIFNOTEXIST="YES"

Specifies whether or not to create a new variable if it does not exist.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMSETENVIRONMENT NAME="Temp" TYPE="USER" VALUE="C:\Documents and Settings\Users\Temp" CREATEIFNOTEXIST="NO" />