Deletes a role specified by its repository id 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 DeleteRole(VGRole role, bool throwOnPopulatedRole) method", true)] public bool DeleteRole( Guid roleId, bool throwOnPopulatedRole ) |
Visual Basic |
---|
<ObsoleteAttribute("Use DeleteRole(VGRole role, bool throwOnPopulatedRole) method", true)> Public Function DeleteRole ( roleId As Guid, throwOnPopulatedRole As Boolean ) As Boolean |
Parameters
- roleId
- Type: System..::..Guid
the repository id of 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. |