Deletes a role specified by its name from the repository.
Namespace: Novalys.VisualGuard.Security.WebFormAssembly: Novalys.VisualGuard.Security.WebForm (in Novalys.VisualGuard.Security.WebForm.dll) Version: 2017.0.101.17 (2017.0.101.17)
Syntax
C# |
---|
public override bool DeleteRole( string roleName, bool throwOnPopulatedRole ) |
Visual Basic |
---|
Public Overrides Function DeleteRole ( roleName As String, throwOnPopulatedRole As Boolean ) As Boolean |
Parameters
- roleName
- Type: System..::..String
the name of role to delete.
- throwOnPopulatedRole
- Type: System..::..Boolean
If true, throws an exception if roleName has one or more members.
Return Value
Type: Booleantrue if the role was deleted from the repository; otherwise; false.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | the value of roleName is null (Nothing in VB.Net). |
System..::..ArgumentException | the value of roleName is an empty string or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ','). |
System..::..InvalidOperationException | the role is marked as a built-in role.
-or- the role has one or more members and throwOnPopulatedRole is true. |
System.Security..::..SecurityException | The current user has not 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. |