GroupPrincipal Class

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v9.0.0

Source:

Group.cs

Encapsulates group accounts. Group accounts can be arbitrary collections of principal objects or accounts created for administrative purposes.

public ref class GroupPrincipal : System::DirectoryServices::AccountManagement::Principal

[System.DirectoryServices.AccountManagement.DirectoryRdnPrefix("CN")]
public class GroupPrincipal : System.DirectoryServices.AccountManagement.Principal

[<System.DirectoryServices.AccountManagement.DirectoryRdnPrefix("CN")>]
type GroupPrincipal = class
    inherit Principal

Public Class GroupPrincipal
Inherits Principal

Inheritance

Object

Principal

GroupPrincipal

Attributes

DirectoryRdnPrefixAttribute

Constructors

GroupPrincipal(PrincipalContext, String)	Initializes a new instance of the GroupPrincipal class and assigns it to the specified context and SAM account name.
GroupPrincipal(PrincipalContext)	Initializes a new instance of the GroupPrincipal class by using the specified context.

Properties

Context	Gets a principal context that is associated with the principal. (Inherited from Principal)
ContextRaw	Gets a principal context that is associated with this principal. (Inherited from Principal)
ContextType	Gets the context type enumeration value that specifies the type of principal context associated with this principal. (Inherited from Principal)
Description	Gets or sets the description of the principal. (Inherited from Principal)
DisplayName	Gets or sets the display name for this principal. (Inherited from Principal)
DistinguishedName	Gets the distinguished name (DN) for this principal. (Inherited from Principal)
GroupScope	Gets or sets a Nullable GroupScope enumeration that specifies the scope for this group principal.
Guid	Gets the GUID associated with this principal. (Inherited from Principal)
IsSecurityGroup	Gets or sets a Nullable Boolean value that indicates whether the group is security-enabled.
Members	Gets a collection of principal objects that represent the members of the group.
Name	Gets or sets the name of this principal. (Inherited from Principal)
SamAccountName	Gets or sets the SAM account name for this principal. (Inherited from Principal)
Sid	Gets the Security ID (SID) of the principal. (Inherited from Principal)
StructuralObjectClass	Gets the structural object class directory attribute. (Inherited from Principal)
UserPrincipalName	Gets or sets the user principal name (UPN) associated with this principal. (Inherited from Principal)

Methods

CheckDisposedOrDeleted()	Determines whether the Dispose() or Delete() methods have been called on this class. This method is called by classes that derive from this principal class. (Inherited from Principal)
Delete()	Deletes the principal object from the store. (Inherited from Principal)
Dispose()	Disposes the current instance of the GroupPrincipal object.
Equals(Object)	Returns a Boolean value that specifies whether the supplied object is equal to the current object. (Inherited from Principal)
ExtensionGet(String)	Retrieves an attribute of an extended class object. (Inherited from Principal)
ExtensionSet(String, Object)	Sets the value of an attribute in an extended class. (Inherited from Principal)
FindByIdentity(PrincipalContext, IdentityType, String)	Returns a group principal object that matches the specified identity type, and value. This version of the FindByIdentity method determines the format of the identity value.
FindByIdentity(PrincipalContext, String)	Returns a group principal object that matches the specified identity value.
GetGroups()	Returns a collection of group objects that specify the groups of which the current principal is a member. (Inherited from Principal)
GetGroups(PrincipalContext)	Returns a collection of group objects that the principal is a member of and that exist in the store provided by the specified context parameter. (Inherited from Principal)
GetHashCode()	Retrieves the hash created from the contents of the principal object, suited for use in hashing algorithms and data structures like a hash table. (Inherited from Principal)
GetMembers()	Returns a collection of the principal objects that is contained in the group.
GetMembers(Boolean)	Returns a collection of the principal objects that is contained in the group. When the recursive flag is set to true, this method searches the current group recursively and returns all nested group members.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUnderlyingObject()	Returns the underlying DirectoryEntry object that provides the contact data for the principal object. (Inherited from Principal)
GetUnderlyingObjectType()	Returns the underlying object type. (Inherited from Principal)
IsMemberOf(GroupPrincipal)	Returns a Boolean value that specifies whether the principal is a member of the specified group. (Inherited from Principal)
IsMemberOf(PrincipalContext, IdentityType, String)	Returns a Boolean value that specifies whether the principal is a member of the group specified by identity type and value. (Inherited from Principal)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Save()	Saves the changes that were made on the principal object to the store. If this is a new principal object, this method inserts it into the store. (Inherited from Principal)
Save(PrincipalContext)	Saves the changes that were made on the principal object to the store. If this is a new principal object, this method inserts it into the specified context. If the principal has already been persisted, it is moved from the original context to the specified context. (Inherited from Principal)
ToString()	Returns a user friendly string representation of the current principal object. (Inherited from Principal)