RoleGroupCollection.GetMatchingRoleGroup メソッド

.NET Framework クラス ライブラリ リファレンス

RoleGroupCollection.GetMatchingRoleGroup メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定したユーザー アカウントが格納されている最初のロール グループを返します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Function GetMatchingRoleGroup ( _
    user As IPrincipal _
) As RoleGroup

Visual Basic (使用法)

Dim instance As RoleGroupCollection
Dim user As IPrincipal
Dim returnValue As RoleGroup

returnValue = instance.GetMatchingRoleGroup(user)

C#

public RoleGroup GetMatchingRoleGroup (
    IPrincipal user
)

C++

public:
RoleGroup^ GetMatchingRoleGroup (
    IPrincipal^ user
)

J#

public RoleGroup GetMatchingRoleGroup (
    IPrincipal user
)

JScript

public function GetMatchingRoleGroup (
    user : IPrincipal
) : RoleGroup

パラメータ

user

ロール グループ コレクションの検索に使用するユーザー アカウントを表す IPrincipal。

戻り値
コレクション内の指定したユーザー アカウントが格納されている最初のロール グループを表す RoleGroup。ユーザーがコレクション内のロール グループに含まれていない場合は、null 参照 (Visual Basic では Nothing) が返されます。

例外

例外の種類	条件
ArgumentNullException	user が null 参照 (Visual Basic では Nothing) です。

解説

GetMatchingRoleGroup メソッドは、ロール グループ コレクションを検索し、指定したユーザー アカウントが格納されている最初のロール グループを返します。このメソッドは、ロール グループがコレクションに追加された順序でコレクション内を検索し、最初に一致したロール グループだけを返します。

指定したユーザー アカウントがコレクション内のどのロール グループにも含まれていない場合は、null 参照 (Visual Basic では Nothing) が返されます。

GetMatchingRoleGroup メソッドを使用するには、ロール管理を構成する必要があります。詳細については、「ロール管理について」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RoleGroupCollection クラス
RoleGroupCollection メンバ
System.Web.UI.WebControls 名前空間
その他の技術情報
ASP.NET ログイン コントロール