Export (0) Print
Expand All

ActiveDirectoryMembershipProvider.UnlockUser Method

Clears a lock so that a membership user can be validated.

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

[DirectoryServicesPermissionAttribute(SecurityAction.Demand, Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.Assert, Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.InheritanceDemand, Unrestricted = true)]
public override bool UnlockUser(
	string username
)

Parameters

username
Type: System.String
The name of the membership user to clear the lock status for.

Return Value

Type: System.Boolean
true if the membership user was successfully unlocked; otherwise, false. The UnlockUser method also returns false when the membership user is not found in the data store.

ExceptionCondition
ArgumentException

username is empty, or exceeds the maximum length allowed for user names (usually 256 characters).

- or -

username contains commas.

- or -

The user name is mapped to userPrincipalName but the username parameter contains backslashes.

ArgumentNullException

username is null.

InvalidOperationException

The UnlockUser method is called before the ActiveDirectoryMembershipProvider instance is initialized.

Users are most commonly locked out and cannot be validated by the ValidateUser method when the MaxInvalidPasswordAttempts property is exceeded within the time specified in the PasswordAttemptWindow property or when too many attempts have been made to log on using the wrong password.

If the EnablePasswordReset property is true, when a user is unlocked the counters for bad passwords are reset.

The provider uses a subtree search starting at the search point specified in the connection string. See the ActiveDirectoryMembershipProvider class topic for more information about connection strings.

Leading and trailing spaces are trimmed from the username parameter value.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft