SqlRoleProvider::RoleExists Method (String^)

 

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

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

public:
virtual bool RoleExists(
	String^ roleName
) override

Parameters

roleName
Type: System::String^

The name of the role to search for in the database.

Return Value

Type: System::Boolean

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

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

An unknown error occurred while communicating with the database.

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

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 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: