This documentation is archived and is not being maintained.

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5
Show: