Deletes a role specified by its name from the repository.

Namespace: Novalys.VisualGuard.Security.Membership
Assembly: 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")]
public bool DeleteRole(
	string roleName,
	bool throwOnPopulatedRole
)
Visual Basic
<ObsoleteAttribute("Use DeleteRole(VGRole role, bool throwOnPopulatedRole) method")> 
Public 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: Boolean
true if the role was deleted from the repository; otherwise; false.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionroleName is null (Nothing in VB.Net).
System..::..ArgumentExceptionroleName is an empty string or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ',') or is longer than 64 characters.
System..::..InvalidOperationExceptionthe role is marked as a built-in role or is a shared role or belongs to another application.

-or-

the role has one or more members and throwOnPopulatedRole is true.
System.Security..::..SecurityExceptionThe 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.

See Also