Principal.IsMemberOf Method (PrincipalContext, IdentityType, 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.

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)

[<SecurityCriticalAttribute>]
member IsMemberOf : 
        context:PrincipalContext *
        identityType:IdentityType *
        identityValue:string -> bool

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.

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

.NET Framework
Available since 3.5

System.DirectoryServices.AccountManagement
IsMemberOf Overload
Principal Class
System.DirectoryServices.AccountManagement Namespace Overview

Return to top
Show: