Export (0) Print
Expand All

EnvironmentPermission.GetPathList Method

Gets all environment variables with the specified EnvironmentPermissionAccess.

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

public string GetPathList(
	EnvironmentPermissionAccess flag
)

Parameters

flag
Type: System.Security.Permissions.EnvironmentPermissionAccess
One of the EnvironmentPermissionAccess values that represents a single type of environment variable access.

Return Value

Type: System.String
A list of environment variables (semicolon-separated) for the selected flag.

ExceptionCondition
ArgumentException

flag is not a valid value of EnvironmentPermissionAccess.

-or-

flag is AllAccess, which represents more than one type of environment variable access, or NoAccess, which does not represent any type of environment variable access.

Use this method to get the state of the current permission. To get both Read and Write access states requires two calls to this method.

NoteNote

The flag parameter is limited to the values of EnvironmentPermissionAccess, which represent single types of environment variable access. Those values are Read and Write. The values acceptable to flag do not include NoAccess and AllAccess, which do not represent single types of environment variable access.

The following code example shows the use of the GetPathList method. This code example is part of a larger example provided for the EnvironmentPermission class.


private bool SetGetPathListDemo()
{
    try
    {
        Console.WriteLine("********************************************************\n");
        Console.WriteLine("Creating an EnvironmentPermission with AllAccess rights for 'TMP'");
        EnvironmentPermission envPerm1 = new EnvironmentPermission(EnvironmentPermissionAccess.AllAccess, "TMP");
        Console.WriteLine("Adding 'TEMP' to the write access list, and 'windir' to the read access list.");
        envPerm1.AddPathList(EnvironmentPermissionAccess.Write, "TEMP");
        envPerm1.AddPathList(EnvironmentPermissionAccess.Read, "windir");
        Console.WriteLine("Read access list before SetPathList = "
            + envPerm1.GetPathList(EnvironmentPermissionAccess.Read));
        Console.WriteLine("Setting read access to 'TMP'");
        envPerm1.SetPathList(EnvironmentPermissionAccess.Read, "TMP");
        Console.WriteLine("Read access list after SetPathList = "
            + envPerm1.GetPathList(EnvironmentPermissionAccess.Read));
        Console.WriteLine("Write access list = " + envPerm1.GetPathList(EnvironmentPermissionAccess.Write));
        Console.WriteLine("Write access environment variables = "
            + envPerm1.GetPathList(EnvironmentPermissionAccess.AllAccess));
    }
    catch (ArgumentException e)
    {
        // EnvironmentPermissionAccess.AllAccess cannot be used as a parameter for GetPathList.
        Console.WriteLine("An ArgumentException occurred as a result of using AllAccess. "
            + " This property cannot be used as a parameter in GetPathList, because it represents "
            + "more than one type of environment variable : \n" + e);
    }

    return true;
}


.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.

Community Additions

ADD
Show:
© 2014 Microsoft