Environment.GetFolderPath Method (System)

GetFolderPath Method

Collapse All

Language Filter

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..::.GetFolderPath Method

Updated: November 2007

Gets the path to the system special folder identified by the specified enumeration.

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

Syntax

Visual Basic (Declaration)

Public Shared Function GetFolderPath ( _
    folder As Environment..::.SpecialFolder _
) As String

Visual Basic (Usage)

Dim folder As Environment..::.SpecialFolder
Dim returnValue As String

returnValue = Environment.GetFolderPath(folder)

public static string GetFolderPath(
    Environment..::.SpecialFolder folder
)

Visual C++

public:
static String^ GetFolderPath(
    Environment..::.SpecialFolder folder
)

public static String GetFolderPath(
    Environment..::.SpecialFolder folder
)

JScript

public static function GetFolderPath(
    folder : Environment..::.SpecialFolder
) : String

Parameters

folder: Type: System..::.Environment..::.SpecialFolder
An enumerated constant that identifies a system special folder.

Return Value

Type: System..::.String

The path to the specified system special folder, if that folder physically exists on your computer; otherwise, the empty string ("").

A folder will not physically exist if the operating system did not create it, the existing folder was deleted, or the folder is a virtual directory, such as My Computer, which does not correspond to a physical path.

Exceptions

Exception	Condition
ArgumentException	folder is not a member of System..::.Environment..::.SpecialFolder.

Remarks

This method retrieves the path to a system special folder, such as Program Files, Programs, System, or Startup, which can be used to access common information. Special folders are set by default by the system, or explicitly by the user, when installing a version of Windows.

The folder parameter designates the special folder to retrieve and must be one of the values in the Environment..::.SpecialFolder enumeration; any other value throws an exception.

For more information about special folders, see the CSIDL values topic.

Examples

The following example demonstrates how to use the GetFolderPath method to return and display the path associated with the folder parameter.

Visual Basic

' Sample for the Environment.GetFolderPath method
Imports System

Class Sample
   Public Shared Sub Main()
      Console.WriteLine()
      Console.WriteLine("GetFolderPath: {0}", Environment.GetFolderPath(Environment.SpecialFolder.System))
   End Sub 'Main
End Class 'Sample
'
'This example produces the following results:
'
'GetFolderPath: C:\WINNT\System32
'

// Sample for the Environment.GetFolderPath method
using System;

class Sample 
{
    public static void Main() 
    {
    Console.WriteLine();
    Console.WriteLine("GetFolderPath: {0}", 
                 Environment.GetFolderPath(Environment.SpecialFolder.System));
    }
}
/*
This example produces the following results:

GetFolderPath: C:\WINNT\System32
*/

Visual C++

// Sample for the Environment::GetFolderPath method
using namespace System;
int main()
{
   Console::WriteLine();
   Console::WriteLine( "GetFolderPath: {0}", Environment::GetFolderPath( Environment::SpecialFolder::System ) );
}

/*
This example produces the following results:

GetFolderPath: C:\WINNT\System32
*/

Permissions

FileIOPermission
for reading directory paths. Associated enumeration: FileIOPermissionAccess..::.PathDiscovery

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360

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.

Version Information