Export (0) Print
Expand All

Environment.GetEnvironmentVariable Method (String, EnvironmentVariableTarget)

Retrieves the value of an environment variable from the current process or from the Windows operating system registry key for the current user or local machine.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

static member GetEnvironmentVariable : 
        variable:string * 
        target:EnvironmentVariableTarget -> string 

Parameters

variable
Type: System.String
The name of an environment variable.
target
Type: System.EnvironmentVariableTarget
One of the EnvironmentVariableTarget values.

Return Value

Type: System.String
The value of the environment variable specified by the variable and target parameters, or a null reference (Nothing in Visual Basic) if the environment variable is not found.

ExceptionCondition
ArgumentNullException

variable is a null reference (Nothing in Visual Basic).

ArgumentException

target is not a valid EnvironmentVariableTarget value.

SecurityException

The caller does not have the required permission to perform this operation.

The target parameter specifies whether the environment variable is retrieved from the current process or from the Windows operating system registry key for the current user or local machine.

Environment variable names are not case-sensitive.

The following example creates environment variables for the Process, User, and Machine targets, checks whether the operating system registry contains the User and Machine environment variables, then deletes the environment variables.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft