RoleService.IsCurrentUserInRole Method

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.

ExceptionCondition
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.

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

Supported in: 4.6, 4.5, 4, 3.5
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft