RolePrincipal::IsInRole Method (String^)

 

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

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

public:
virtual bool IsInRole(
	String^ role
) override

Parameters

role
Type: System::String^

The role to search for.

Return Value

Type: System::Boolean

true if user represented by the RolePrincipal is in the specified role; otherwise, false.

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.

The following code example checks to see whether the logged-on user is in the Administrators role before allowing the user to view user roles.

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

.NET Framework
Available since 2.0
Return to top
Show: