EnvironmentPermission.SetPathList Method (EnvironmentPermissionAccess, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sets the specified access to the specified environment variables to the existing state of the permission.

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

public void SetPathList(
	EnvironmentPermissionAccess flag,
	string pathList
)

Parameters

flag
Type: System.Security.Permissions.EnvironmentPermissionAccess

One of the EnvironmentPermissionAccess values.

pathList
Type: System.String

A list of environment variables (semicolon-separated).

Exception Condition
ArgumentNullException

The pathList parameter is null.

ArgumentException

The flag parameter is not a valid value of EnvironmentPermissionAccess.

The previous state of the current permission is overwritten.

The following code example shows the use of the SetPathList 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
Available since 1.1
Return to top
Show: