Export (0) Print
Expand All

IPermission.IsSubsetOf Method

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

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

bool IsSubsetOf (
	IPermission target
)
boolean IsSubsetOf (
	IPermission target
)
function IsSubsetOf (
	target : IPermission
) : boolean
Not applicable.

Parameters

target

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

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

Exception typeCondition

ArgumentException

The target parameter is not a null reference (Nothing in Visual Basic) 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 a null reference (Nothing in Visual Basic).

  • 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 a null reference (Nothing in Visual Basic), 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 override Boolean IsSubsetOf(IPermission target) 
{
    // If 'target' is null and this permission allows nothing, return true.
    if (target == null) return m_flags == 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 m_flags <= soundPerm.m_flags;
}

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft