Edit

MembershipUser.UnlockUser Method

  • Reference

Definition

Namespace:
System.Web.Security
Assembly:
System.Web.dll
Assembly:
System.Web.ApplicationServices.dll

Clears the locked-out state of the user so that the membership user can be validated.

public:
 virtual bool UnlockUser();
public virtual bool UnlockUser ();
abstract member UnlockUser : unit -> bool
override this.UnlockUser : unit -> bool
Public Overridable Function UnlockUser () As Boolean

Returns

Boolean

true if the membership user was successfully unlocked; otherwise, false.

Exceptions

PlatformNotSupportedException

This method is not available. This can occur if the application targets the .NET Framework 4 Client Profile. To prevent this exception, override the method, or change the application to target the full version of the .NET Framework.

Remarks

Users are most commonly locked out and cannot be validated by the ValidateUser method when the MaxInvalidPasswordAttempts is reached within the PasswordAttemptWindow.

Users can also be locked out if you use the GetPassword or ResetPassword overload that accepts a password answer and the number of bad answers entered by the user reaches the value of Membership.MaxInvalidPasswordAttempts within the Membership.PasswordAttemptWindow.

Your implementation of this method should set the IsLockedOut property to false, set the LastLockoutDate property to the current date, and reset any counters that you use to track the number of failed log in attempts and so forth.

Applies to

See also