SqlRoleProvider.DeleteRole Method (String, Boolean)


Removes a role from the role database.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

Public Overrides Function DeleteRole (
	roleName As String,
	throwOnPopulatedRole As Boolean
) As Boolean


Type: System.String

The name of the role to delete.

Type: System.Boolean

If true, throws an exception if roleName has one or more members.

Return Value

Type: System.Boolean

true if the role was successfully deleted; otherwise, false.

Exception Condition

roleName is null (Nothing in Visual Basic).


roleName is an empty string or contains a comma.


roleName is longer than 256 characters.


roleName has one or more members and throwOnPopulatedRole is true.


An unknown error occurred while communicating with the database.

The DeleteRole method is called by the Roles class to delete a role from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). When a role is deleted, the list of users associated with that role is also deleted from the database. The user information in the database is not affected.

If throwOnPopulatedRole is true, then an exception will be thrown and the role will not be deleted if the role identified by the roleName parameter has one or more members. If throwOnPopulatedRole is false, then the role will be deleted whether it is empty or not.

The following example deletes a role from the database. For an example of a Web.config file that enables role management, see SqlRoleProvider.

<%@ Page Language="VB" %>

<%@ Import Namespace="System.Web.Security" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

  Dim rolesArray() As String

  Public Sub Page_Load(ByVal sender As Object, ByVal args As EventArgs)

    If Not IsPostBack Then
      ' Bind roles to ListBox.

      rolesArray = Roles.GetAllRoles()
      RolesListBox.DataSource = rolesArray
    End If

  End Sub

  Public Sub DeleteRole_OnClick(ByVal sender As Object, ByVal args As EventArgs)

    Dim delRole As String

      delRole = RolesListBox.SelectedItem.Value


      Msg.Text = "Role '" & Server.HtmlEncode(delRole) & "' deleted."

      ' Re-bind roles to ListBox.

      rolesArray = Roles.GetAllRoles()
      RolesListBox.DataSource = rolesArray
      Msg.Text = "Role '" & Server.HtmlEncode(delRole) & "' <u>not</u> deleted."
    End Try

  End Sub


<html xmlns="http://www.w3.org/1999/xhtml" >
  <title>Sample: Delete Role</title>
  <form runat="server" id="PageForm">
      Delete Role</h3>
    <asp:Label ID="Msg" ForeColor="maroon" runat="server" /><br />
    <table border="0">
        <td valign="top">
          Delete Role:</td>
        <td valign="top">
          <asp:ListBox ID="RolesListBox" runat="server" Rows="8" /></td>
        <td valign="top">
          <asp:Button Text="Delete Role" ID="DeleteRoleButton" runat="server" OnClick="DeleteRole_OnClick" /></td>

.NET Framework
Available since 2.0
Return to top