RoleService.IsCurrentUserInRole(String) Method

Reference

Definition

Namespace:: System.Web.ApplicationServices

Assembly:: System.Web.Extensions.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 bool IsCurrentUserInRole(System::String ^ role);

[System.ServiceModel.OperationContract]
public bool IsCurrentUserInRole (string role);

[<System.ServiceModel.OperationContract>]
member this.IsCurrentUserInRole : string -> bool

Public Function IsCurrentUserInRole (role As String) As Boolean

Parameters

role: String

The name of the role to check.

Returns

Boolean

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

Attributes: OperationContractAttribute

Exceptions

ArgumentNullException

role is null or the user is not logged in.

ProviderException

Role management is not enabled.

Remarks

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

Note

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.

Applies to