Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 2.94 KB

HelpersSetEnvironmentVariable.md

File metadata and controls

101 lines (69 loc) · 2.94 KB
Raw

Set-EnvironmentVariable

NOTE: Administrative Access Required when -Scope 'Machine'.

DO NOT USE. Not part of the public API. Use Install-ChocolateyEnvironmentVariable instead.

Syntax

Set-EnvironmentVariable `
  -Name <String> `
  [-Value <String>] `
  [-Scope {Process | User | Machine}] `
  [-IgnoredArguments <Object[]>] [<CommonParameters>]

Description

Saves an environment variable.

Notes

This command will assert UAC/Admin privileges on the machine if -Scope 'Machine'.

Aliases

None

Inputs

None

Outputs

None

Parameters

-Name <String>

Property Value
Aliases
Required? true
Position? 1
Default Value
Accept Pipeline Input? false

-Value [<String>]

Property Value
Aliases
Required? false
Position? 2
Default Value
Accept Pipeline Input? false

-Scope

Valid options: Process, User, Machine

Property Value
Aliases
Required? false
Position? 3
Default Value
Accept Pipeline Input? false

-IgnoredArguments [<Object[]>]

Allows splatting with arguments that do not apply. Do not use directly.

Property Value
Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/p/?LinkID=113216 .

Links

  • [[Install-ChocolateyEnvironmentVariable|HelpersInstallChocolateyEnvironmentVariable]]
  • [[Uninstall-ChocolateyEnvironmentVariable|HelpersUninstallChocolateyEnvironmentVariable]]
  • [[Install-ChocolateyPath|HelpersInstallChocolateyPath]]
  • [[Get-EnvironmentVariable|HelpersGetEnvironmentVariable]]

[[Function Reference|HelpersReference]]

NOTE: This documentation has been automatically generated from Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Set-EnvironmentVariable -Full.

View the source for Set-EnvironmentVariable