Roles.IsUserInRole Method (String, String)

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

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

public:
static bool IsUserInRole (
	String^ username, 
	String^ roleName
)
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.

Exception typeCondition

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.

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: