Deletes the role represented by the specified VGRole object from the repository.
Namespace: Novalys.VisualGuard.Security.MembershipAssembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2017.0.101.17 (2017.0.101.17)
Syntax
C# |
---|
public bool DeleteRole( VGRole role, bool throwOnPopulatedRole ) |
Visual Basic |
---|
Public Function DeleteRole ( role As VGRole, throwOnPopulatedRole As Boolean ) As Boolean |
Parameters
- role
- Type: Novalys.VisualGuard.Security.Membership..::..VGRole
A VGRole representing the 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..::..InvalidOperationException | the role is marked as a built-in role or is a shared role.
-or- the role has one or more members and throwOnPopulatedRole is true. |
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. |