RoleExists Method

Roles.RoleExists Method (String)


Gets a value indicating whether the specified role name already exists in the role data source.

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

public static bool RoleExists(
	string roleName


Type: System.String

The name of the role to search for in the data source.

Return Value

Type: System.Boolean

true if the role name already exists in the data source; otherwise, false.

Exception Condition

roleName is null (Nothing in Visual Basic).


roleName is an empty string or contains a comma (,).


Role management is not enabled.

The RoleExists method calls the RoleExists method of the default role provider to determine whether a role name exists in the data source for the application that is specified in the ApplicationName property.

The following code example uses the RoleExists method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see Roles.

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.

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