AuthenticablePrincipal.UnlockAccount Method

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v8.0.0

Source:

AuthenticablePrincipal.cs

Unlocks the account if it is currently locked out.

public:
 void UnlockAccount();

public void UnlockAccount ();

member this.UnlockAccount : unit -> unit

Public Sub UnlockAccount ()

Exceptions

PrincipalOperationException

The caller does not have appropriate rights.

-or-

An exception occurred when saving the changes to the store.

Examples

The following example code connects to the LDAP domain "fabrikam.com" with the username (administrator) and password (SecretPwd123) initialized in the PrincipalContext constructor.

A search is performed to find the user with name "John Smith" under the container specified in the PrincipalContext constructor: "CN=Users,DC=fabrikam,DC=com." If the user is found, a check is performed to determine whether this user's account has been locked out. If the account has been locked out, the code example unlocks the account.

PrincipalContext ctx = new PrincipalContext(ContextType.Domain,   
                                         "fabrikam.com",   
                                         "CN=Users,DC=fabrikam,DC=com",   
                                         "administrator",   
                                         "SecretPwd123");  

UserPrincipal usr = UserPrincipal.FindByIdentity(ctx, "John Smith");  
if (usr != null)  
{  
    if (usr.IsAccountLockedOut())  
        usr.UnlockAccount();  

    usr.Dispose();  
}  
ctx.Dispose();