This documentation is archived and is not being maintained.

SqlRoleProvider::CreateRole Method

Adds a new role to the role database.

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

public:
virtual void CreateRole(
	String^ roleName
) override

Parameters

roleName
Type: System::String
The name of the role to create.

ExceptionCondition
System::ArgumentNullException

roleName is nullptr.

System::ArgumentException

roleName is an empty string or contains a comma.

-or-

roleName is longer than 256 characters.

System.Configuration.Provider::ProviderException

roleName already exists in the database.

-or-

An unknown error occurred while communicating with the database.

The CreateRole method is called by the Roles class to create a role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config).

The maximum length for the role name is 256 characters. Role names are not case-sensitive. Commas are not allowed in role names.

The following code example creates a new role in the database. 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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: