AuthorizationStoreRoleProvider.GetRolesForUser メソッド

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

AuthorizationStoreRoleProvider.GetRolesForUser メソッド

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

ユーザーに割り当てられたロールのリストを取得します。

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

Visual Basic (宣言)

Public Overrides Function
 GetRolesForUser ( _
    username As String _
) As String()

Visual Basic (使用法)

Dim instance As AuthorizationStoreRoleProvider
Dim username As String
Dim returnValue As String()

returnValue = instance.GetRolesForUser(username)

C#

public override string[] GetRolesForUser (
    string username
)

C++

public:
virtual array<String^>^ GetRolesForUser (
    String^ username
) override

J#

public String[] GetRolesForUser (
    String username
)

JScript

public override function GetRolesForUser (
    username : String
) : String[]

パラメータ

username

ロールの一覧を取得するユーザー。

戻り値
指定ユーザーに割り当てられたすべてのロールの名前を格納している文字列配列。

例外

例外の種類	条件
ArgumentNullException	username が null 参照 (Visual Basic では Nothing) です。
ArgumentException	username にコンマが含まれています。
ProviderException	構成済みの applicationName が見つかりませんでした。 または 構成済みの scopeName が見つかりませんでした。 または 承認マネージャ ランタイムがサーバーにインストールされていません。
FileNotFoundException	connectionStringName 属性が、存在しないファイルへの接続文字列を参照しています。
HttpException	AuthorizationStoreRoleProvider インスタンスが、ファイル ベースのポリシー ストアを使用するように構成されていますが、そのポリシー ファイルへの読み込みアクセスが現在の信頼レベルで許可されていません。

解説

GetRolesForUser メソッドは Roles クラスによって呼び出され、ASP.NET アプリケーションの構成ファイル (Web.config) に指定されている承認マネージャ ポリシー ストアから、指定したユーザーのロールの一覧を取得します。

使用例

GetRolesForUser メソッドを使用して、指定されたユーザーのロールの一覧を取得し、System.Web.UI.WebControls.GridView コントロールにバインドするコード例を次に示します。ロール管理を有効にする Web.config ファイルの例については、AuthorizationStoreRoleProvider のトピックを参照してください。

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security"
 %>
<script runat="server">

Dim rolesArray() As String
Dim users As MembershipUserCollection

Public Sub Page_Load()

  Msg.Text = ""

  Try
    If Not Roles.IsUserInRole(User.Identity.Name,
 "Administrators") Then
      Msg.Text = "You are not authorized to view user roles."
      UsersListBox.Visible = False
      Return
    End If
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership
 cannot be verified."
    Return
  End Try


  If Not IsPostBack Then
    ' Bind users to ListBox.

    users = Membership.GetAllUsers()
    UsersListBox.DataSource = users
    UsersListBox.DataBind()
  End If


  ' If a user is selected, show the roles for the selected user.

  If Not UsersListBox.SelectedItem Is
 Nothing Then
    ' Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value)
    UserRolesGrid.DataSource = rolesArray
    UserRolesGrid.DataBind()

    UserRolesGrid.Columns(0).HeaderText = "Roles for "
 & UsersListBox.SelectedItem.Value
  End If

End Sub

</script>
<html>
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon"
 runat="server" /><BR>

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:ListBox id="UsersListBox"
 DataTextField="Username" 
                                    Rows="8" AutoPostBack="true"
 runat="server" /></td>
      <td valign="top"><asp:GridView runat="server"
 CellPadding="4" id="UserRolesGrid"
 
                                     AutoGenerateColumns="false"
 Gridlines="None" 
                                     CellSpacing="0"
 >
                         <HeaderStyle BackColor="navy"
 ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles"
 runat="server" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

C#

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<script runat="server">

string[] rolesArray;
MembershipUserCollection users;

public void Page_Load()
{
  Msg.Text = "";

  try
  {
    if (!Roles.IsUserInRole(User.Identity.Name, "Administrators"))
    {
      Msg.Text = "You are not authorized to view user roles.";
      UsersListBox.Visible = false;
      return;
    }
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be
 verified.";
    return;
  }


  if (!IsPostBack)
  {
    // Bind users to ListBox.

    users = Membership.GetAllUsers();
    UsersListBox.DataSource = users;
    UsersListBox.DataBind();
  }


  // If a user is selected, show the roles for the selected user.

  if (UsersListBox.SelectedItem != null)
  {
    // Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value);
    UserRolesGrid.DataSource = rolesArray;
    UserRolesGrid.DataBind();

    UserRolesGrid.Columns[0].HeaderText = "Roles for "
 + UsersListBox.SelectedItem.Value;
  }
}

</script>
<html>
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server"
 /><BR>

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:ListBox id="UsersListBox"
 DataTextField="Username" 
                                    Rows="8" AutoPostBack="true"
 runat="server" /></td>
      <td valign="top"><asp:GridView runat="server"
 CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false"
 Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white"
 />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" runat="server"
 >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

プラットフォーム

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

参照

関連項目
AuthorizationStoreRoleProvider クラス
AuthorizationStoreRoleProvider メンバ
System.Web.Security 名前空間
その他の技術情報
ロール管理について