This documentation is archived and is not being maintained.

Roles.IsUserInRole Method (String)

Gets a value indicating whether the currently logged-on user is in the specified role.

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

static member IsUserInRole : 
        roleName:string -> bool 

Parameters

roleName
Type: System.String
The name of the role to search in.

Return Value

Type: System.Boolean
true if the currently logged-on user is in the specified role; otherwise, false.

ExceptionCondition
System.ArgumentNullException

roleName is a null reference (Nothing in Visual Basic).

-or-

There is no current logged-on user.

System.ArgumentException

roleName is an empty string or contains a comma (,).

System.Configuration.Provider.ProviderException

Role management is not enabled.

The IsUserInRole method calls the RoleProvider.IsUserInRole method of the default role provider to determine whether the currently logged-on user is associated with a role from the data source for the application that is specified in the ApplicationName property. The currently logged-on user is identified by the HttpContext.User property of the current System.Web.HttpContext, or by Thread.CurrentPrincipal for non-HTTP hosting environments. If no user is logged on, an exception will be thrown. Only the roles for the application that is specified in the ApplicationName property are retrieved.

If CacheRolesInCookie is true, then roleName may be checked against the roles cache rather than the specified role provider.

The following code example programmatically checks whether the currently logged-on user is in the Administrators role before allowing the user to view roles settings for the application. For an example of a Web.config file that enables role management, see Roles.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: