CreateRole Method

RoleProvider.CreateRole Method

Adds a new role to the data source for the configured applicationName.

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

public abstract void CreateRole(
	string roleName


Type: System.String

The name of the role to create.

CreateRole is called by the CreateRole method of the Roles class to add the specified role to the data source for the configured ApplicationName.

If the specified role name already exists for the configured applicationName, is null, or is an empty string, we recommend that your provider throw an exception.

If the specified role name contains a comma, we recommend that your provider throw an exception.

If your data source restricts the length of the role name, for example, through a fixed-length column of a table in a database, we recommend that you throw an exception if the role name exceeds the maximum length allowed by the data source.

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

public override void CreateRole(string rolename)
  if (rolename == null || rolename == "")
    throw new ProviderException("Role name cannot be empty or null.");
  if (rolename.Contains(","))
    throw new ArgumentException("Role names cannot contain commas.");
  if (RoleExists(rolename))
    throw new ProviderException("Role name already exists.");
  if (rolename.Length > 255)
    throw new ProviderException("Role name cannot exceed 255 characters.");

  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("INSERT INTO Roles "  +
                                    " (Rolename, ApplicationName) " +
                                    " Values(?, ?)", conn);

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


  catch (OdbcException)
    // Handle exception.

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

© 2016 Microsoft