RoleProvider.IsUserInRole Method (String, String)

 

Gets a value indicating whether the specified user is in the specified role for the configured applicationName.

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

abstract IsUserInRole : 
        username:string *
        roleName:string -> bool

Parameters

username
Type: System.String

The user name to search for.

roleName
Type: System.String

The role to search in.

Return Value

Type: System.Boolean

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

The IsUserInRole method is called by the IsUserInRole method of the Roles class to determine whether the current logged-on user is associated with a role from the data source for the configured ApplicationName.

If the specified user name is null or is an empty string, we recommend that your provider throw an exception.

If the specified role name is null or is an empty string, we recommend that your provider throw an exception.

The following code example shows a sample implementation of the IsUserInRole method.

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

.NET Framework
Available since 2.0
Return to top
Show: