Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
System Namespace
Environment Class
 GetEnvironmentVariables Method
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
Environment..::.GetEnvironmentVariables Method

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

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
Visual Basic (Declaration)
Public Shared Function GetEnvironmentVariables As IDictionary
Visual Basic (Usage)
Dim returnValue As IDictionary

returnValue = Environment.GetEnvironmentVariables()
C#
public static IDictionary GetEnvironmentVariables()
Visual C++
public:
static IDictionary^ GetEnvironmentVariables()
JScript
public static function GetEnvironmentVariables() : IDictionary

Return Value

Type: System.Collections..::.IDictionary
An IDictionary 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 code example demonstrates the GetEnvironmentVariables method.

Visual Basic
' Sample for the Environment.GetEnvironmentVariables method
Imports System
Imports System.Collections

Class Sample
   Public Shared Sub Main()
      Console.WriteLine()
      Console.WriteLine("GetEnvironmentVariables: ")
      Dim environmentVariables As IDictionary = Environment.GetEnvironmentVariables()
      Dim de As DictionaryEntry
      For Each de In  environmentVariables
         Console.WriteLine("  {0} = {1}", de.Key, de.Value)
      Next de
   End Sub 'Main
End Class 'Sample
'
'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 "!---OMITTED---!".)
'
'GetEnvironmentVariables: 
'  !---OMITTED---!
'
C#
// Sample for the Environment.GetEnvironmentVariables method
using System;
using System.Collections;

class Sample 
{
    public static void Main() 
    {
    Console.WriteLine();
    Console.WriteLine("GetEnvironmentVariables: ");
    IDictionary    environmentVariables = Environment.GetEnvironmentVariables();
    foreach (DictionaryEntry de in environmentVariables)
        {
        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 "!---OMITTED---!".)

GetEnvironmentVariables: 
  !---OMITTED---!
*/
Visual C++
// 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---!
*/

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker