This documentation is archived and is not being maintained.

Principal.IsMemberOf Method (PrincipalContext, IdentityType, String)

Returns a Boolean value that specifies whether the principal is a member of the group specified by identity type and value.

Namespace:  System.DirectoryServices.AccountManagement
Assembly:  System.DirectoryServices.AccountManagement (in System.DirectoryServices.AccountManagement.dll)

public bool IsMemberOf(
	PrincipalContext context,
	IdentityType identityType,
	string identityValue
)

Parameters

context
Type: System.DirectoryServices.AccountManagement.PrincipalContext

The PrincipalContext that specifies the server or domain against which operations are performed.

identityType
Type: System.DirectoryServices.AccountManagement.IdentityType

A IdentityType enumeration value that specifies the type of the identity value.

identityValue
Type: System.String

The identity of the group.

Return Value

Type: System.Boolean
true if the principal is a member of the specified group; otherwise false.

ExceptionCondition
NoMatchingPrincipalException

The identity type or value does not correspond to a GroupPrincipal.

MultipleMatchesException

More than one matching GroupPrincipal was found.

If the current principal is an AD DS principal, the returned groups include the principal's primary group, as indicated by the primary group ID attribute on the AD DS object.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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.

.NET Framework

Supported in: 3.5
Show: