This documentation is archived and is not being maintained.

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)

'Declaration
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<DirectoryServicesPermissionAttribute(SecurityAction.InheritanceDemand, Unrestricted := True)> _
<DirectoryServicesPermissionAttribute(SecurityAction.Demand, Unrestricted := True)> _
<DirectoryServicesPermissionAttribute(SecurityAction.Assert, Unrestricted := True)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Overrides Function UnlockUser ( _
	username As String _
) As Boolean
'Usage
Dim instance As ActiveDirectoryMembershipProvider 
Dim username As String 
Dim returnValue As Boolean 

returnValue = instance.UnlockUser(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 Nothing.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: