This documentation is archived and is not being maintained.

Environment::GetEnvironmentVariables Method

Retrieves all environment variable names and their values from the current process.

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

public:
static IDictionary^ GetEnvironmentVariables()

Return Value

Type: System.Collections::IDictionary
A dictionary that contains all environment variable names and their values; otherwise, an empty dictionary if no environment variables are found.

ExceptionCondition
SecurityException

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

OutOfMemoryException

The buffer is out of memory.

The names and values for the environment variables are stored as key-value pairs in the returned IDictionary.

The following example demonstrates the GetEnvironmentVariables method.


// Sample for the Environment::GetEnvironmentVariables method
using namespace System;
using namespace System::Collections;
int main()
{
   Console::WriteLine();
   Console::WriteLine( "GetEnvironmentVariables: " );
   IDictionary^ environmentVariables = Environment::GetEnvironmentVariables();
   IEnumerator^ myEnum = environmentVariables->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      DictionaryEntry^ de = safe_cast<DictionaryEntry^>(myEnum->Current);
      Console::WriteLine( " {0} = {1}", de->Key, de->Value );
   }
}

/*
This example produces the following results:
(Any result that is lengthy, specific to the machine on which this sample was tested, or reveals information that should remain secure, has been omitted and marked S"!---OMITTED---!".)

GetEnvironmentVariables:
!---OMITTED---!
*/


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.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.
Show: