RoleService.IsCurrentUserInRole Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Determines whether the logged-in user belongs to the specified role.

Namespace:   System.Web.ApplicationServices
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

[OperationContractAttribute]
public bool IsCurrentUserInRole(
	string role
)

Parameters

role
Type: System.String

The name of the role to check.

Return Value

Type: System.Boolean

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

Exception Condition
ArgumentNullException

role is null or the user is not logged in.

ProviderException

Role management is not enabled.

The IsCurrentUserInRole method checks whether the logged-in user belongs to the specified role. The IsCurrentUserInRole method raises the SelectingProvider event.

System_CAPS_noteNote

Do not call the IsCurrentUserInRole method from code that is executing on the Web server. You call the IsCurrentUserInRole method only as part of a WCF service. For more information about how to check whether a user belongs to the specified group from code executing on the Web server, see the IsUserInRole method.

.NET Framework
Available since 3.5
Return to top
Show: