1 out of 3 rated this helpful - Rate this topic

Environment.GetEnvironmentVariable Method (String)

.NET Framework 4.5

Retrieves the value of an environment variable from the current process.

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

public static string GetEnvironmentVariable(
	string variable
)

Parameters

variable: Type: System.String
The name of the environment variable.

Return Value

Type: System.String
The value of the environment variable specified by variable, or null if the environment variable is not found.

Exceptions

Exception	Condition
ArgumentNullException	variable is null.
SecurityException	The caller does not have the required permission to perform this operation.

Remarks

Environment variable names are not case-sensitive.

Examples

The following example demonstrates the GetEnvironmentVariable method.

C++

		// Change the directory to %WINDIR%							
		Environment.CurrentDirectory = Environment.GetEnvironmentVariable("windir");		
		DirectoryInfo info = new DirectoryInfo(".");
        	lock(info)
        	{      
			Console.WriteLine("Directory Info:   "+info.FullName);
        	}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

EnvironmentPermission
for the ability to read the value of variable. Associated enumeration: EnvironmentPermissionAccess.Read

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

Environment Class

GetEnvironmentVariable Overload

System Namespace

GetEnvironmentVariables

SetEnvironmentVariable

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)