Edit

ActiveDirectoryMembershipProvider.UnlockUser(String) Method

  • Reference

Definition

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

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

public:
 override bool UnlockUser(System::String ^ username);
public override bool UnlockUser (string username);
override this.UnlockUser : string -> bool
Public Overrides Function UnlockUser (username As String) As Boolean

Parameters

username
String

The name of the membership user to clear the lock status for.

Returns

Boolean

true if the membership user was successfully unlocked; otherwise, false. The UnlockUser(String) method also returns false when the membership user is not found in the data store.

Exceptions

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(String) method is called before the ActiveDirectoryMembershipProvider instance is initialized.

Remarks

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.

Applies to

See also