VGMembershipInstanceDeleteUser Method (String) |
Note: This API is now obsolete.
Deletes a user from the repository.
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 DeleteUser(VGMembershipUser user)")] public bool DeleteUser( string username )
Parameters
- username
- Type: SystemString
The name of the user to delete.
Return Value
Type: Booleantrue if the user was deleted; otherwise, false.
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | username is null. |
| ArgumentException | username is empty or is longer than 64 characters or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ','). |
| 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. |
RemarksThis method deletes the user even if the user is a member of another application.
See Also