RolePrincipal.IsInRole Method (String)
Gets a value indicating whether the user represented by the RolePrincipal is in the specified role.
Assembly: System.Web (in System.Web.dll)
Parameters
- role
-
Type:
System.String
The role to search for.
Return Value
Type: System.Booleantrue if user represented by the RolePrincipal is in the specified role; otherwise, false.
Implements
IPrincipal.IsInRole(String)| Exception | Condition |
|---|---|
| ProviderException | The Identity property is null. |
IsInRole first checks the IsRoleListCached property to determine whether a cached list of role names for the current user is available. If the IsRoleListCached property is true, the cached list is checked for the specified role. If the IsInRole method finds the specified role in the cached list, it returns true.
If IsInRole does not find the specified role, it calls the GetRolesForUser method of the default Provider instance to determine whether the user name is associated with a role from the data source for the configured ApplicationName value.
Available since 2.0