Visual Guard Class Library Documentation

VGRoleProvider.DeleteRole Method

Deletes a role specified by its name from the repository.

public override bool DeleteRole(
String roleName,
Boolean throwOnPopulatedRole
);

Parameters

roleName: the name of 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
ArgumentNullException	the value of roleName is null (Nothing in VB.Net).
ArgumentException	the value of roleName is an empty string or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '\|', '[', ']', '+', '=', ',').
InvalidOperationException	the role is marked as a built-in 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

VGRoleProvider Class | Novalys.VisualGuard.Security.WebForm Namespace