ActiveDirectoryMembershipProvider.UnlockUser(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Clears a lock so that a membership user can be validated.
public:
override bool UnlockUser(System::String ^ username);public override bool UnlockUser (string username);override this.UnlockUser : string -> boolPublic Overrides Function UnlockUser (username As String) As BooleanParameters
- username
- String
The name of the membership user to clear the lock status for.
Returns
true if the membership user was successfully unlocked; otherwise, false. The UnlockUser(String) method also returns false when the membership user is not found in the data store.
Exceptions
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 null.
The UnlockUser(String) method is called before the ActiveDirectoryMembershipProvider instance is initialized.
Remarks
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.
