ActiveDirectoryMembershipProvider.UnlockUser Method
Assembly: System.Web (in system.web.dll)
public boolean UnlockUser ( String username )
public override function UnlockUser ( username : String ) : boolean
Not applicable.
Parameters
- username
The name of the membership user to clear the lock status for.
Return Value
true if the membership user was successfully unlocked; otherwise, false. The UnlockUser method also returns false when the membership user is not found in the data store.| Exception type | Condition |
|---|---|
|
username is empty, or exceeds the maximum length allowed for user names (usually 256 characters). - or - username contains commas. - or - The user name is mapped to userPrincipalName but the username parameter contains backslashes. | |
|
username is a null reference (Nothing in Visual Basic). | |
|
The UnlockUser method is called before the ActiveDirectoryMembershipProvider instance is initialized. |
Users are most commonly locked out and cannot be validated by the ValidateUser method when the MaxInvalidPasswordAttempts property is exceeded within the time specified in the PasswordAttemptWindow property or when too many attempts have been made to log on using the wrong password.
If the EnablePasswordReset property is true, when a user is unlocked the counters for bad passwords are reset.
The provider uses a subtree search starting at the search point specified in the connection string. See the ActiveDirectoryMembershipProvider class topic for more information about connection strings.
Leading and trailing spaces are trimmed from the username parameter value.