SqlRoleProvider.CreateRole Method (String)

 

Adds a new role to the role database.

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

override CreateRole : 
        roleName:string -> unit

Parameters

roleName
Type: System.String

The name of the role to create.

Exception Condition
System.ArgumentNullException

roleName is null.

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.

System_CAPS_security Security 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
Available since 2.0
Return to top
Show: