RoleGroupCollection.GetMatchingRoleGroup Method (IPrincipal)

 

Returns the first role group that contains the specified user account.

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

public RoleGroup GetMatchingRoleGroup(
	IPrincipal user
)

Parameters

user
Type: System.Security.Principal.IPrincipal

An IPrincipal that represents the user account to find the role group collection.

Return Value

Type: System.Web.UI.WebControls.RoleGroup

A RoleGroup representing the first role group in the collection that contains the specified user account. If the user is not part of a role group in the collection, it returns null.

Exception Condition
ArgumentNullException

user is null.

The GetMatchingRoleGroup method searches the role group collection and returns the first role group that contains the specified user account. The method searches the collection in the order role groups are added to the collection, and returns only the first matching role group.

If the specified user account is not part of any of the role groups in the collection, null is returned.

You must configure role management to use the GetMatchingRoleGroup method. For more information, see Understanding Role Management.

.NET Framework
Available since 2.0
Return to top
Show: