Roles.GetRolesForUser メソッド

リファレンス

定義

名前空間:: System.Web.Security

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

オーバーロード

GetRolesForUser()	現在ログオンしているユーザーに割り当てられているロールのリストを取得します。
GetRolesForUser(String)	ユーザーに割り当てられたロールのリストを取得します。

GetRolesForUser()

現在ログオンしているユーザーに割り当てられているロールのリストを取得します。

public:
 static cli::array <System::String ^> ^ GetRolesForUser();

public static string[] GetRolesForUser ();

static member GetRolesForUser : unit -> string[]

Public Shared Function GetRolesForUser () As String()

戻り値

String[]

現在ログオンしているユーザーに割り当てられているすべてのロールの名前を格納している文字列配列。

例外

ArgumentNullException

現在ログオンしているユーザーはありません。

ProviderException

ロール管理は有効になっていません。

例

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

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

string[] rolesArray;

public void Page_Load()
{
  if (!IsPostBack)
  {
    // Bind roles to GridView.

    try
    {
      rolesArray = Roles.GetRolesForUser();
    }
    catch (HttpException e)
    {
      Msg.Text = "There is no current logged on user. Role information cannot be retrieved.";
      return;
    }

    UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
    UserRolesGrid.DataSource = rolesArray;
    UserRolesGrid.DataBind();
  }
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<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:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load()
  If Not IsPostBack Then
    ' Bind roles to GridView.

    Try
      rolesArray = Roles.GetRolesForUser()
    Catch e As HttpException
      Msg.Text = "There is no current logged on user. Role information cannot be retrieved."
      Return
    End Try

    UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
    UserRolesGrid.DataSource = rolesArray
    UserRolesGrid.DataBind()
  End If
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<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:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

注釈

メソッドは GetRolesForUser 、既定のロールプロバイダーのメソッドを呼び出 RoleProvider.GetRolesForUser して、現在ログオンしているユーザーが存在するロールをデータソースから取得します。現在ログオンしているユーザーは、現在System.Web.HttpContextののプロパティ、HttpContext.Userまたは HTTP 以外のホスティング環境の場合はによってThread.CurrentPrincipal識別されます。ログオンしているユーザーがいない場合は、例外がスローされます。プロパティで指定されているアプリケーションの ApplicationName ロールのみが取得されます。

が trueの場合CacheRolesInCookie、メソッドのGetRolesForUser結果は、指定されたロールプロバイダーではなく、ロールキャッシュから返される可能性があります。

こちらもご覧ください

ロール管理 ASP.NET 理解する

適用対象

GetRolesForUser(String)

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

public:
 static cli::array <System::String ^> ^ GetRolesForUser(System::String ^ username);

public static string[] GetRolesForUser (string username);

static member GetRolesForUser : string -> string[]

Public Shared Function GetRolesForUser (username As String) As String()

パラメーター

username: String

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

戻り値

String[]

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

例外

ArgumentNullException

username が nullです。

ArgumentException

username にコンマ (,) が含まれています。

ProviderException

ロール管理は有効になっていません。

例

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

string[] rolesArray;

public void Page_Load()
{
  if (!IsPostBack)
  {
    // Bind roles to GridView.

    try
    {
      rolesArray = Roles.GetRolesForUser();
    }
    catch (HttpException e)
    {
      Msg.Text = "There is no current logged on user. Role information cannot be retrieved.";
      return;
    }

    UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
    UserRolesGrid.DataSource = rolesArray;
    UserRolesGrid.DataBind();
  }
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<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:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load()
  If Not IsPostBack Then
    ' Bind roles to GridView.

    Try
      rolesArray = Roles.GetRolesForUser()
    Catch e As HttpException
      Msg.Text = "There is no current logged on user. Role information cannot be retrieved."
      Return
    End Try

    UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
    UserRolesGrid.DataSource = rolesArray
    UserRolesGrid.DataBind()
  End If
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<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:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

注釈

メソッドは GetRolesForUser 、 RoleProvider.GetRolesForUser 既定のロールプロバイダーのメソッドを呼び出して、ユーザーが存在するロールをデータソースから取得します。プロパティで指定されているアプリケーションの ApplicationName ロールのみが取得されます。

が現在ログオンしているユーザーとCacheRolesInCookie等しく、がの場合username、メソッドのGetRolesForUser結果はtrue、指定した Providerではなくロールキャッシュから返される可能性があります。

こちらもご覧ください

ロール管理 ASP.NET 理解する

適用対象

次の方法で共有

Roles.GetRolesForUser メソッド

定義

オーバーロード

GetRolesForUser()

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

GetRolesForUser(String)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

その他のリソース