MembershipProvider.UnlockUser(String) Method

Definition

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

public:
 abstract bool UnlockUser(System::String ^ userName);
public abstract bool UnlockUser (string userName);
abstract member UnlockUser : string -> bool
Public MustOverride Function UnlockUser (userName As String) As Boolean

Parameters

userName
String

The membership user whose lock status you want to clear.

Returns

true if the membership user was successfully unlocked; otherwise, false.

Examples

For an example of a MembershipProvider implementation, see Implementing a Profile Provider.

Remarks

Takes, as input, a user name, and updates the field in the data source that stores the IsLockedOut property to false. The UnlockUser method returns true if the record for the membership user is updated successfully; otherwise, false.

Applies to

See also