SqlMembershipProvider.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 the user's locked-out status so that the membership user can be validated.
public:
override bool UnlockUser(System::String ^ username);
public override bool UnlockUser (string username);
override this.UnlockUser : string -> bool
Public Overrides Function UnlockUser (username As String) As Boolean
Parameters
- username
- String
The name of the membership user to clear the locked-out status for.
Returns
true
if the membership user was successfully unlocked; otherwise, false
. A value of false
is also returned if the user does not exist in the database.
Exceptions
username
is an empty string, is longer than 256 characters, or contains a comma.
username
is null
.
Remarks
Users are most commonly locked out and cannot be validated by the ValidateUser method when the MaxInvalidPasswordAttempts is exceeded within the PasswordAttemptWindow.
Leading and trailing spaces are trimmed from the username
parameter value.