SqlRoleProvider::IsUserInRole Method (String^, String^)

 

Gets a value indicating whether the specified user is in the specified role.

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

public:
virtual bool IsUserInRole(
	String^ username,
	String^ roleName
) override

Parameters

username
Type: System::String^

The user name to search for.

roleName
Type: System::String^

The role to search in.

Return Value

Type: System::Boolean

true if the specified user name is in the specified role; otherwise, false.

Exception Condition
System::ArgumentNullException

roleName is null.

-or-

username is null.

System::ArgumentException

roleName is an empty string or contains a comma.

-or-

username is contains a comma.

-or-

roleName is longer than 256 characters.

-or-

username is longer than 256 characters.

System.Configuration.Provider::ProviderException

An unknown error occurred while communicating with the database.

The IsUserInRole method is called by the Roles class and the IsInRole method of the Page::User property to determine whether a user is associated with a role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config).

The following code example programmatically checks to see whether the logged-on user is in the Administrators role before allowing the user to view user roles. For an example of a Web.config file that enables role management, see SqlRoleProvider.

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

.NET Framework
Available since 2.0
Return to top
Show: