2.2.1.5.1 Element-Specific Attributes

Attribute name

Description

action

(optional) If specified, the value MUST be C, D, R, or U, corresponding to Create, Delete, Replace, and Update. If unspecified, the default value is U. The value descriptions are:

Create: This action MUST be used to create a new environment variable or to add a semicolon-delimited segment to the PATH<5> environment variable for computers or users. If the environment variable exists, then the protocol MUST NOT create a new environment variable and MUST NOT return an error.

Delete: This action MUST be used to remove an environment variable or to delete a semicolon-delimited segment from the PATH environment variable from computers or users. The protocol MUST NOT perform an action if the environment variable does not exist and MUST NOT return an error.

Replace: This action MUST be used to delete and re-create an environment variable. The net result of the Replace action MUST be to overwrite all existing settings associated with the environment variable. If the environment variable does not exist, then the Replace action MUST create a new environment variable.

Update: This action MUST be used to modify settings of an existing environment variable. This action differs from Replace in that it MUST update only settings defined within the preference item. All other settings MUST remain as configured on the environment variable. If the environment variable does not exist, then the Update action MUST create a new environment variable.

user

(optional) To cause the environment variable to affect each user independently, this attribute MUST be set to 0. The environment variable is stored in the registry in HKEY_CURRENT_USER. To cause the environment variable to affect only the default user of the computer, this MUST be set to 1.

name

MUST set a name for the environment variable to which the action applies. To select the PATH variable, this field MUST be blank or MUST specify PATH.

partial

(optional) To add or delete a semicolon-delimited segment of the value of the PATH variable, this variable MUST be set to 1. This value applies only when both System Variable and PATH are set.

value

MUST set the value of the environment variable.