RoleGroupCollection.GetMatchingRoleGroup(IPrincipal) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns the first role group that contains the specified user account.
public:
System::Web::UI::WebControls::RoleGroup ^ GetMatchingRoleGroup(System::Security::Principal::IPrincipal ^ user);public System.Web.UI.WebControls.RoleGroup GetMatchingRoleGroup (System.Security.Principal.IPrincipal user);member this.GetMatchingRoleGroup : System.Security.Principal.IPrincipal -> System.Web.UI.WebControls.RoleGroupPublic Function GetMatchingRoleGroup (user As IPrincipal) As RoleGroupParameters
- user
- IPrincipal
An IPrincipal that represents the user account to find the role group collection.
Returns
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.
Exceptions
user is null.
Remarks
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.
