RoleGroup::ContainsUser Method (IPrincipal^)

 

Indicates whether the specified user is a member of any of the roles in the role group.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public:
bool ContainsUser(
	IPrincipal^ user
)

Parameters

user
Type: System.Security.Principal::IPrincipal^

The user name to look for in the role group.

Return Value

Type: System::Boolean

true if the user is a member of one of the roles associated with this role group; otherwise, false.

Exception Condition
ArgumentNullException

User is null.

The ContainsUser method returns true if the specified user is a member of any of the roles associated with this role group. Roles are searched in the order they are listed in the Roles property, and searching stops after the first match is found.

This method uses the IsUserInRole method to determine whether a user is a member of a role. You must configure role management to use the ContainsUser method. For more information, see Understanding Role Management.

.NET Framework
Available since 2.0
Return to top
Show: