VGMembershipInstanceLockUser Method (String) |
Note: This API is now obsolete.
Clears the user's unlocked-out status so that the membership user can be validated.
Namespace: Novalys.VisualGuard.Security.Membership
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
Syntax[ObsoleteAttribute("Use LockUser(VGMembershipUser user) method")] public bool LockUser( string username )
Parameters
- username
- Type: SystemString
The name of the membership user to clear the unlocked-out status for.
Return Value
Type: Booleantrue if the membership user was successfully locked; otherwise, false. A value of false is also returned if the user does not exist in the database.
Exceptions| Exception | Condition |
|---|---|
| ArgumentException | username is an empty string, is longer than 64 characters, or contains invalid characters ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ','). |
| ArgumentNullException | username is null. |
| SecurityException | The current user does not have enough privileges to use Membership API. The Membership access level of the application must be sufficient to allows this action or the 'Membership Manager' role must be granted to the user by using the Visual Guard console. |
See Also