This documentation is archived and is not being maintained.
Environment::GetEnvironmentVariable Method (String)
Visual Studio 2010
Retrieves the value of an environment variable from the current process.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- variable
- Type: System::String
The name of the environment variable.
Return Value
Type: System::StringThe value of the environment variable specified by variable, or nullptr if the environment variable is not found.
| Exception | Condition |
|---|---|
| ArgumentNullException | variable is nullptr. |
| SecurityException | The caller does not have the required permission to perform this operation. |
The following example demonstrates the GetEnvironmentVariable method.
// Change the directory to %WINDIR% Environment::CurrentDirectory = Environment::GetEnvironmentVariable( "windir" ); DirectoryInfo^ info = gcnew DirectoryInfo( "." ); System::Threading::Monitor::Enter( info ); try { Console::WriteLine( "Directory Info: {0}", info->FullName ); } finally { System::Threading::Monitor::Exit( info ); }
- EnvironmentPermission
for the ability to read the value of variable. Associated enumeration: EnvironmentPermissionAccess::Read
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.
Show: