Deletes a user from the repository.
Namespace: Novalys.VisualGuard.Security.MembershipAssembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2016.0.105.16 (2016.0.105.16)
Syntax
C# |
---|
[ObsoleteAttribute("Use DeleteUser(VGMembershipUser user)")] public bool DeleteUser( string username ) |
Visual Basic |
---|
<ObsoleteAttribute("Use DeleteUser(VGMembershipUser user)")> Public Function DeleteUser ( username As String ) As Boolean |
Parameters
- username
- Type: System..::..String
The name of the user to delete.
Return Value
Type: Booleantrue if the user was deleted; otherwise, false.
Remarks
This method deletes the user even if the user is a member of another application.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | username is null. |
System..::..ArgumentException | username is empty or is longer than 64 characters or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ','). |
System.Security..::..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. |