This documentation is archived and is not being maintained.
Principal Class
Visual Studio 2010
Encapsulates the account data and operations common to all security principals. This is the abstract base class from which all security principals are derived.
System::Object
System.DirectoryServices.AccountManagement::Principal
System.DirectoryServices.AccountManagement::AuthenticablePrincipal
System.DirectoryServices.AccountManagement::GroupPrincipal
System.DirectoryServices.AccountManagement::Principal
System.DirectoryServices.AccountManagement::AuthenticablePrincipal
System.DirectoryServices.AccountManagement::GroupPrincipal
Assembly: System.DirectoryServices.AccountManagement (in System.DirectoryServices.AccountManagement.dll)
The Principal type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Context | Gets a principal context that is associated with the principal. |
![]() | ContextRaw | Gets a principal context that is associated with this principal. |
![]() | ContextType | Gets the context type enumeraton value that specifies the type of principal context associated with this principal. |
![]() | Description | Gets or sets the description of the principal. |
![]() | DisplayName | Gets or sets the display name for this principal. |
![]() | DistinguishedName | Gets the distinguished name (DN) for this principal. |
![]() | Guid | Gets the GUID associated with this principal. |
![]() | Name | Gets or sets the name of this principal. |
![]() | SamAccountName | Gets or sets the SAM account name for this principal. |
![]() | Sid | Gets the Security ID (SID) of the principal. |
![]() | StructuralObjectClass | Gets the structural object class directory attribute. |
![]() | UserPrincipalName | Gets or sets the user principal name (UPN) associated with this principal. |
| Name | Description | |
|---|---|---|
![]() | 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. |
![]() | Delete | Deletes the principal object from the store. |
![]() | Dispose | Disposes the current instance of the Principal object. |
![]() | Equals | Returns a Boolean value that specifies whether the supplied object is equal to the current object. (Overrides Object::Equals(Object).) |
![]() | ExtensionGet | Retrieves an attribute of an extended class object. |
![]() | ExtensionSet | Sets the value of an attribute in an extended class. |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | FindByIdentity(PrincipalContext, String) | Returns a principal object that matches the specified identity value. |
![]() ![]() | FindByIdentity(PrincipalContext, IdentityType, String) | Returns a principal object that matches the specified identity type, and value. This version of the FindByIdentity() method determines the format of the identity value. |
![]() ![]() | FindByIdentityWithType(PrincipalContext, Type, String) | Returns a principal object that matches the specified identity type, and value. This method is called by the implementation of the derived-class FindByIdentity method to restrict the search to the derived class type and is not intended to be called directly from your code. |
![]() ![]() | FindByIdentityWithType(PrincipalContext, Type, IdentityType, String) | Returns a principal object that matches the specified identity type, and value. This method is called by the implementation of the derived-class FindByIdentity method to restrict the search to the derived class type and is not intended to be called directly from your code. |
![]() | GetGroups() | Returns a collection of group objects that specify the groups of which the current principal is a member. |
![]() | 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. |
![]() | 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. (Overrides Object::GetHashCode().) |
![]() | 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. |
![]() | GetUnderlyingObjectType | Returns the underlying object type. |
![]() | IsMemberOf(GroupPrincipal) | Returns a Boolean value that specifies whether the principal is a member of the specified group. |
![]() | 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. |
![]() | 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. |
![]() | 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. |
![]() | ToString | Returns a user friendly string representation of the current principal object. (Overrides Object::ToString().) |
Custom extension classes that derive from this class can call this constructor from the derived class constructor to initialize the base class. For more information, see the Principal Extensions overview topic.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show:
