GetAllRoles Method

RoleProvider.GetAllRoles Method ()


Gets a list of all the roles for the configured applicationName.

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

public abstract string[] GetAllRoles()

Return Value

Type: System.String[]

A string array containing the names of all the roles stored in the data source for the configured applicationName.

GetAllRoles is called by the GetAllRoles method of the Roles class to retrieve a list of role names from the data source. Only the roles for the specified ApplicationName are retrieved.

If no roles exist for the configured applicationName, we recommend that your provider return a string array with no elements.

The following code example shows a sample implementation of the GetAllRoles method.

public override string[] GetAllRoles()
  string tmpRoleNames = "";

  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("SELECT Rolename FROM Roles "  +
                                    " WHERE ApplicationName = ?", conn);

  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;

  OdbcDataReader reader = null;


    reader = cmd.ExecuteReader();

    while (reader.Read())
      tmpRoleNames += reader.GetString(0) + ",";
  catch (OdbcException)
    // Handle exception.
    if (reader != null) { reader.Close(); }

  if (tmpRoleNames.Length > 0)
    // Remove trailing comma.
    tmpRoleNames = tmpRoleNames.Substring(0, tmpRoleNames.Length - 1);
    return tmpRoleNames.Split(',');

  return new string[0];

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft