Roles::IsUserInRole Method (String^, String^)

 

Gets a value indicating whether the specified user is in the specified role. The API is only intended to be called within the context of an ASP.NET request thread, and in that sanctioned use case it is thread-safe.

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

public:
static bool IsUserInRole(
	String^ username,
	String^ roleName
)

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::Boolean

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

Exception Condition
System::ArgumentNullException

roleName is null.

-or-

username is null.

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.

.NET Framework
Available since 2.0
Return to top
Show: