Skip to content

Environment element

Environment variables added or removed for the parent component.

Attributes

Action

Specfies whether the environmental variable should be created, set or removed when the parent component is installed. This attribute’s value must be one of the following:

  • create: Creates the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists.
  • set: Creates the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation.
  • remove: Removes the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value attributes. If you want to remove an environment variable, regardless of its value, do not set the Value attribute.

Id

string

Unique identifier for environment entry.

Name

string required

Name of the environment variable.

Part

This attribute’s value must be one of the following:

  • all: This value is the entire environmental variable. This is the default.
  • first: This value is prefixed.
  • last: This value is appended.

Permanent

yesno

Specifies that the environment variable should not be removed on uninstall.

Separator

string

Optional attribute to change the separator used between values. By default a semicolon is used.

System

yesno

Specifies that the environment variable should be added to the system environment space. The default is ‘no’ which indicates the environment variable is added to the user environment space.

Value

string

The value to set into the environment variable. If this attribute is not set, the environment variable is removed during installation if it exists on the machine.

Parents

Component

Windows Installer references

Environment Table