SqlMembershipProvider.UnlockUser Method (String)


Clears the user's locked-out status so that the membership user can be validated.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

override UnlockUser : 
        username:string -> bool


Type: System.String

The name of the membership user to clear the locked-out status for.

Return Value

Type: System.Boolean

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.

Exception Condition

username is an empty string, is longer than 256 characters, or contains a comma.


username is null.

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.

.NET Framework
Available since 2.0
Return to top