Roles.IsUserInRole Method (String, String)
.NET Framework 3.0
Gets a value indicating whether the specified user is in the specified role.
Namespace: System.Web.Security
Assembly: System.Web (in system.web.dll)
Roles Members
System.Web.Security Namespace
Assembly: System.Web (in system.web.dll)
public static boolean IsUserInRole ( String username, String roleName )
public static function IsUserInRole ( username : String, roleName : String ) : boolean
Not applicable.
Parameters
- username
The name of the user to search for.
- roleName
The name of the role to search in.
Return Value
true if the specified user is in the specified role; otherwise, false.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.
Reference
Roles ClassRoles Members
System.Web.Security Namespace
Other Resources
Understanding Role ManagementCommunity Additions
ADD
Show: