Creates or modifies environment variables in the user or system environment, without requiring programming or scripting. The Setx command also retrieves the values of registry keys and writes them to text files.
For examples of how to use this command, see Examples.
Syntax
setx [/s <Computer> [/u [<Domain>\]<User name> [/p [<Password>]]]] <Variable> <Value> [/m]
setx [/s <Computer> [/u [<Domain>\]<User name> [/p [<Password>]]]] [<Variable>] /k <Path> [/m]
setx [/s <Computer> [/u [<Domain>\]<User name> [/p [<Password>]]]] /f <FileName> {[<Variable>] {/a <X>,<Y> | /r <X>,<Y> "<String>"} [/m] | /x} [/d <Delimiters>]
Parameters
| Parameter | Description |
|---|---|
|
/s <Computer> |
Specifies the name or IP address of a remote computer. Do not use backslashes. The default value is the name of the local computer. |
|
/u [<Domain>\]<User name> |
Runs the script with the credentials of the specified user account. The default value is the system permissions. |
|
/p [<Password>] |
Specifies the password of the user account that is specified in the /u parameter. |
|
<Variable> |
Specifies the name of the environment variable that you want to set. |
|
<Value> |
Specifies the value to which you want to set the environment variable. |
|
/k <Path> |
Specifies that the variable is set based on information from a registry key. The path uses the following syntax:
For example, you might specify the following path:
|
|
/f <File name> |
Specifies the file that you want to use. |
|
/a <X>,<Y> |
Specifies absolute coordinates and offset as search parameters. |
|
/r <X>,<Y> "<String>" |
Specifies relative coordinates and offset from String as search parameters. |
|
/m |
Specifies to set the variable in the system environment. The default setting is the local environment. |
|
/x |
Displays file coordinates, ignoring the /a, /r, and /d command-line options. |
|
/d <Delimiters> |
Specifies delimiters such as "," or "\" to be used in addition to the four built-in delimiters — SPACE, TAB, ENTER, and LINEFEED. Valid delimiters include any ASCII character. The maximum number of delimiters is 15, including built-in delimiters. |
|
/? |
Displays help at the command prompt. |
Remarks
- The Setx command is similar to the UNIX utility
SETENV.
- Setx provides the only command-line or programmatic way
to directly and permanently set system environment values. System
environment variables are manually configurable through Control
Panel or through a registry editor. The set command,
which is internal to the command interpreter (Cmd.exe), sets user
environment variables for the current console window only.
- You can use the setx command to set values for user and
system environment variables from one of three sources (modes):
Command Line Mode, Registry Mode, or File Mode.
- Setx writes variables to the master environment in the
registry. Variables set with setx variables are available in
future command windows only, not in the current command window.
- HKEY_CURRENT_USER and HKEY_LOCAL_MACHINE are the
only supported hives. REG_DWORD, REG_EXPAND_SZ, REG_SZ, and
REG_MULTI_SZ are the valid RegKey data types.
- When you gain access to REG_MULTI_SZ values in the
registry, only the first item is extracted and used.
- You cannot use the setx command to remove values that
have been added to the local or system environments. You can use
set with a variable name and no value to remove a
corresponding value from the local environment.
- REG_DWORD registry values are extracted and used in hexadecimal
mode.
- File mode supports the parsing of carriage return and line feed
(CRLF) text files only.
Examples
To set the MACHINE environment variable in the local environment to the value Brand1, type:
setx MACHINE Brand1
To set the MACHINE environment variable in the system environment to the value Brand1 Computer, type:
setx MACHINE "Brand1 Computer" /m
To set the MYPATH environment variable in the local environment to use the search path defined in the PATH environment variable, type:
setx MYPATH %PATH%
To set the MYPATH environment variable in the local environment to use the search path defined in the PATH environment variable after replacing ~ with %, type:
setx MYPATH ~PATH~
To set the MACHINE environment variable in the local environment to Brand1 on a remote computer named Computer1, type:
setx /s computer1 /u maindom\hiropln /p p@ssW23 MACHINE Brand1
To set the MYPATH environment variable in the local environment to use the search path defined in the PATH environment variable on a remote computer named Computer1, type:
setx /s computer1 /u maindom\hiropln /p p@ssW23 MYPATH %PATH%
To set the TZONE environment variable in the local environment to the value found in the HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\TimeZoneInformation\StandardName registry key, type:
setx TZONE /k HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\TimeZoneInformation\StandardName
To set the TZONE environment variable in the local environment of a remote computer named Computer1 to the value found in the HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\TimeZoneInformation\StandardName registry key, type:
setx /s computer1 /u maindom\hiropln /p p@ssW23 TZONE /k HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\TimeZoneInformation\StandardName
To set the BUILD environment variable in the system environment to the value found in the HKEY_LOCAL_MACHINE\Software\Microsoft\WindowsNT\CurrentVersion\CurrentBuildNumber registry key, type:
setx BUILD /k "HKEY_LOCAL_MACHINE\Software\Microsoft\WindowsNT\CurrentVersion\CurrentBuildNumber" /m
To set the BUILD environment variable in the system environment of a remote computer named Computer1 to the value found in the HKEY_LOCAL_MACHINE\Software\Microsoft\WindowsNT\CurrentVersion\CurrentBuildNumber registry key, type:
setx /s computer1 /u maindom\hiropln /p p@ssW23 BUILD /k "HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\CurrentBuildNumber" /m
To display the contents of a file named Ipconfig.out, along with the contents' corresponding coordinates, type:
setx /f ipconfig.out /x
To set the IPADDR environment variable in the local environment to the value found at the coordinate 5,11 in the file Ipconfig.out, type:
setx IPADDR /f ipconfig.out /a 5,11
To set the OCTET1 environment variable in the local environment to the value found at the coordinate 5,3 in the file Ipconfig.out with delimiters "#$*.", type:
setx OCTET1 /f ipconfig.out /a 5,3 /d "#$*."
To set the IPGATEWAY environment variable in the local environment to the value found at the coordinate 0,7 with respect to the coordinate of "Gateway" in the file Ipconfig.out, type:
setx IPGATEWAY /f ipconfig.out /r 0,7 Gateway
To display the contents of a file named Ipconfig.out — along with the contents' corresponding coordinates — on a computer named Computer1, type:
setx /s computer1 /u maindom\hiropln /p p@ssW23 /f ipconfig.out /x