Environment Element

WiX Help

Environment Element

Description

Environment variables added or removed for parent Component

Windows Installer references
Environment Table
Parents
Component, Include
Inner Text
None
Children
None
Attributes
Name Type Description Required
Id String Unique identifier for environment entry. Yes
Action Enumeration Specfies whether the environmental variable should be created, set or removed when the parent component is installed. This attribute's value should 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 fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty.
 
Name String Name of the environment variable. Yes
Part Enumeration This attribute's value should be one of the following:
all
This value is the entire environmental variable.
first
This value is prefixed.
last
This value is appended.
 
Permanent YesNoType 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 semi-colon is used.  
System YesNoType 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 Value to set into the environment variable.  
See Also
Wix Schema