GetAllRoles Method

SqlRoleProvider.GetAllRoles Method

Gets a list of all the roles for the application.

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

public override string[] GetAllRoles()

Return Value

Type: System.String[]
A string array containing the names of all the roles stored in the database for a particular application.


An unknown error occurred while communicating with the database.

The GetAllRoles method is called by the Roles class to retrieve a list of all the roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config).

The following code example uses the GetAllRoles method to get the list of roles for an application and bind the results to a System.Web.UI.WebControls.GridView control. For an example of a Web.config file that enables role management, see SqlRoleProvider.

Security noteSecurity Note:

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
<script runat="server">

string[] rolesArray;

public void Page_Load(object sender, EventArgs args)
  if (!IsPostBack)
    // Bind roles to GridView.

    rolesArray = Roles.GetAllRoles();
    RolesGrid.DataSource = rolesArray;

public void CreateRole_OnClick(object sender, EventArgs args)
  string createRole = RoleTextBox.Text;

    if (Roles.RoleExists(createRole))
      Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' already exists. Please specify a different role name.";


    Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' created.";

    // Re-bind roles to GridView.

    rolesArray = Roles.GetAllRoles();
    RolesGrid.DataSource = rolesArray;
  catch (Exception e)
    Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' <u>not</u> created.";


<html xmlns="" >
<title>Sample: Create Role</title>

<form runat="server" id="PageForm">
  <h3>Create a Role</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  Role name: 

  <asp:TextBox id="RoleTextBox" runat="server" />

  <asp:Button Text="Create Role" id="CreateRoleButton"
              runat="server" OnClick="CreateRole_OnClick" />

  <br />

  <asp:GridView runat="server" CellPadding="2" id="RolesGrid" 
                Gridlines="Both" CellSpacing="2" AutoGenerateColumns="false" >
    <HeaderStyle BackColor="navy" ForeColor="white" />
      <asp:TemplateField HeaderText="Roles" >
          <%# Container.DataItem.ToString() %>


Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

© 2015 Microsoft