Visual Guard Class Library Documentation

VGRoles.DeleteRole Method (Guid, Boolean)

Deletes a role specified by its repository id from the repository.

public static bool DeleteRole(
   Guid roleId,
   Boolean throwOnPopulatedRole
);

Parameters

roleId
the repository id of the role to delete.
throwOnPopulatedRole
If true, throws an exception if roleName has one or more members.

Return Value

true if the role was deleted from the repository; otherwise; false.

Exceptions

Exception Type Condition
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.
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.

See Also

VGRoles Class | Novalys.VisualGuard.Security.Membership Namespace | VGRoles.DeleteRole Overload List | RepositoryId