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)
Visual Basic (Declaration)
Public Shared Function IsUserInRole ( _
roleName As String _
) As Boolean
Dim roleName As String
Dim returnValue As Boolean
returnValue = Roles.IsUserInRole(roleName)
public static bool IsUserInRole(
string roleName
)
public:
static bool IsUserInRole(
String^ roleName
)
public static function IsUserInRole(
roleName : String
) : boolean
Return Value
Type:
System..::.Boolean
true if the currently logged-on user is in the specified role; otherwise, false.
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.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
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, 3.0, 2.0
Reference
Other Resources