Roles.IsUserInRole Method (String, String)
Gets a value indicating whether the specified user is in the specified role.
Assembly: System.Web (in System.Web.dll)
Parameters
- username
- Type: System.String
The name of the user to search for.
- roleName
- Type: System.String
The name of the role to search in.
Return Value
Type: System.Booleantrue if the specified user is in the specified role; otherwise, false.
| Exception | Condition |
|---|---|
| System.ArgumentNullException | roleName is a null reference (Nothing in Visual Basic). -or- username is a null reference (Nothing in Visual Basic). |
| System.ArgumentException | roleName is an empty string or contains a comma (,). -or- username contains a comma (,). |
| System.Configuration.Provider.ProviderException | Role management is not enabled. |
The IsUserInRole method calls the IsUserInRole method of the default role provider to determine whether a user name is associated with a role from the data source for the application that is specified in the ApplicationName property.
If username is equal to the current logged-on user and the CacheRolesInCookie property value is true, roleName may be checked against the role cache rather than the specified Provider.
The following code example programmatically checks whether a 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.