This documentation is archived and is not being maintained.

RoleGroupCollection::GetMatchingRoleGroup Method

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 nullptr.

ExceptionCondition
ArgumentNullException

user is nullptr.

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, nullptr is returned.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: