IPermission::IsSubsetOf Method (IPermission^)

 
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.

Determines whether the current permission is a subset of the specified permission.

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

bool IsSubsetOf(
	IPermission^ target
)

Parameters

target
Type: System.Security::IPermission^

A permission that is to be tested for the subset relationship. This permission must be of the same type as the current permission.

Return Value

Type: System::Boolean

true if the current permission is a subset of the specified permission; otherwise, false.

Exception Condition
ArgumentException

The target parameter is not null and is not of the same type as the current permission.

The current permission is a subset of the specified permission if the current permission specifies a set of operations that is wholly contained by the specified permission. For example, a permission that represents access to C:\example.txt is a subset of a permission that represents access to C:\. If this method returns true, the current permission represents no more access to the protected resource than does the specified permission.

The following statements are required to be true for all implementations of the IsSubsetOf method. X, Y, and Z represent IPermission objects that are not null.

  • X.IsSubsetOf(X) returns true.

  • X.IsSubsetOf(Y) returns the same value as Y.IsSubsetOf(X) if and only if X and Y represent the same set of permissions.

  • If X.IsSubsetOf(Y) and Y.IsSubsetOf(Z) both return true, X.IsSubsetOf(Z) returns true.

If X represents an empty IPermission object with a permission state of None and Y represents an IPermission object that is null, X.IsSubsetOf(Y) returns true. If Z is also an empty permission, the compound set operation X.Union(Z).IsSubsetOf(Y) also returns true because the union of two empty permissions is an empty permission.

The following code example demonstrates implementing the IsSubsetOf method. This code example is part of a larger example provided for the IPermission class.

    // Called by the Demand method: returns true 
    // if 'this' is a subset of 'target'.
public:
    virtual bool IsSubsetOf(IPermission^ target) override
    {
        // If 'target' is null and this permission allows nothing, 
        // return true.
        if (target == nullptr)
        {
            return (int)stateFlags == 0;
        }

        // Both objects must be the same type.
        SoundPermission^ soundPerm = VerifyTypeMatch(target);

        // Return true if the permissions of 'this' 
        // is a subset of 'target'.
        return stateFlags <= soundPerm->stateFlags;
    }

.NET Framework
Available since 1.1
Return to top
Show: