Export (0) Print
Expand All

SqlMembershipProvider::UnlockUser Method

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)

public:
virtual bool UnlockUser(
	String^ username
) override

Parameters

username
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.

ExceptionCondition
System::ArgumentException

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

System::ArgumentNullException

username is nullptr.

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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft