AuthorizationStoreRoleProvider::IsUserInRole Method (String^, String^)
Gets a value indicating whether the specified user is in the specified role.
Assembly: System.Web (in System.Web.dll)
Parameters
- username
-
Type:
System::String^
The user name to search for.
- roleName
-
Type:
System::String^
The role to search in.
Return Value
Type: System::Booleantrue if the specified user name is in the specified role; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentNullException | username is null. -or roleName is null. |
| ArgumentException | roleName is an empty string. -or- roleName contains a comma. -or- username contains a comma. |
| ProviderException | The configured applicationName was not found. -or- The configured scopeName was not found. -or- The authorization-manager runtime is not installed on the server. |
| FileNotFoundException | The connectionStringName attribute references a connection string to a file that does not exist. |
| HttpException | The AuthorizationStoreRoleProvider instance is configured with a file-based policy store, and read access to the file is not allowed at the current trust level. |
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 authorization-manager data store 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 AuthorizationStoreRoleProvider.
Available since 2.0