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 override bool UnlockUser (
	string username
)
public boolean UnlockUser (
	String username
)
public override function UnlockUser (
	username : String
) : boolean
Not applicable.

Parameters

username

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

Return Value

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 typeCondition

System.ArgumentException

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

System.ArgumentNullException

username is a null reference (Nothing in Visual Basic).

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.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft