SqlRoleProvider.AddUsersToRoles メソッドとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

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

索引トップ用語の索引ランキング

SqlRoleProvider.AddUsersToRoles メソッド

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

指定された各ロールに、指定されたユーザー名を追加します。

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

Visual Basic (宣言)

Public Overrides Sub AddUsersToRoles
 ( _
    usernames As String(), _
    roleNames As String() _
)

Visual Basic (使用法)

Dim instance As SqlRoleProvider
Dim usernames As String()
Dim roleNames As String()

instance.AddUsersToRoles(usernames, roleNames)

public override void AddUsersToRoles (
    string[] usernames,
    string[] roleNames
)

C++

public:
virtual void AddUsersToRoles (
    array<String^>^ usernames, 
    array<String^>^ roleNames
) override

public void AddUsersToRoles (
    String[] usernames, 
    String[] roleNames
)

JScript

public override function AddUsersToRoles (
    usernames : String[], 
    roleNames : String[]
)

パラメータ

usernames: 指定されたロールに追加するユーザー名の文字列配列。

roleNames: 指定されたユーザー名の割り当て先となるロール名の文字列配列。

例外

例外の種類	条件
System.ArgumentNullException	roleNames のロールの 1 つが null 参照 (Visual Basic では Nothing) です。または usernames のユーザーの 1 つが null 参照 (Visual Basic では Nothing) です。
System.ArgumentException	roleNames のロールの 1 つが空の文字列か、またはコンマ (,) を含んでいます。または usernames のロールの 1 つが空の文字列か、またはコンマ (,) を含んでいます。または roleNames のロールの 1 つが 256 文字を超えています。または usernames のユーザーの 1 つが 256 文字を超えています。または roleNames に重複した要素が含まれています。または usernames に重複した要素が含まれています。
System.Configuration.Provider.ProviderException	指定された 1 つ以上のロール名が見つかりませんでした。または指定された 1 つ以上のユーザー名が見つかりませんでした。または指定された 1 つ以上のユーザー名が、指定された 1 つ以上のロール名に既に関連付けられています。またはデータベースとの通信中に不明なエラーが発生しました。

例外の種類

条件

System.ArgumentNullException

roleNames のロールの 1 つが null 参照 (Visual Basic では Nothing) です。

または

usernames のユーザーの 1 つが null 参照 (Visual Basic では Nothing) です。

System.ArgumentException

roleNames のロールの 1 つが空の文字列か、またはコンマ (,) を含んでいます。

または

usernames のロールの 1 つが空の文字列か、またはコンマ (,) を含んでいます。

または

roleNames のロールの 1 つが 256 文字を超えています。

または

usernames のユーザーの 1 つが 256 文字を超えています。

または

roleNames に重複した要素が含まれています。

または

usernames に重複した要素が含まれています。

System.Configuration.Provider.ProviderException

指定された 1 つ以上のロール名が見つかりませんでした。

または

指定された 1 つ以上のユーザー名が見つかりませんでした。

または

指定された 1 つ以上のユーザー名が、指定された 1 つ以上のロール名に既に関連付けられています。

または

データベースとの通信中に不明なエラーが発生しました。

解説

AddUsersToRoles メソッドは、Roles クラスによって呼び出され、1 つ以上のユーザーを、ASP.NET アプリケーションの構成ファイル (Web.config) に指定されている SQL Server データベースの 1 つ以上のロールに関連付けます。このメソッドは、Roles クラスの AddUserToRole、AddUserToRoles、AddUsersToRole、AddUsersToRoles の各メソッドによって呼び出されます。

AddUsersToRoles メソッドの呼び出し中に実行されるデータベース更新は、1 つのトランザクション内で行われます。指定されたロールに既にユーザー名が存在するなどのエラーが発生した場合、トランザクションがロールバックされ、更新は実行されません。

SqlRoleProvider を SqlMembershipProvider と共に使用し、指定されたユーザー名の 1 つがデータベースに存在しない場合、そのユーザー名は自動的にデータベースに追加されます。

ユーザー名およびロール名にコンマを使用することはできません。

使用例

次のコード例では、1 つ以上のユーザーをロールに追加し、ロールからユーザーを削除しています。ロール管理を有効にする Web.config ファイルの例については、SqlRoleProvider のトピックを参照してください。

Visual Basic

<%@ Page Language="VB" %>

<%@ Import Namespace="System.Web.Security"
 %>
<%@ Import Namespace="System.Web.UI"
 %>

<script runat="server">

  Dim rolesArray() As String
  Dim users As MembershipUserCollection
  Dim usersInRole() As String

  Public Sub Page_Load()

    Msg.Text = ""

    If Not IsPostBack Then
      ' Bind roles to ListBox.

      rolesArray = Roles.GetAllRoles()
      RolesListBox.DataSource = rolesArray
      RolesListBox.DataBind()

      ' Bind users to ListBox.

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

    If Not RolesListBox.SelectedItem Is
 Nothing Then
      ' Show users in role. Bind user list to GridView.

      usersInRole = Roles.GetUsersInRole(RolesListBox.SelectedItem.Value)
      UsersInRoleGrid.DataSource = usersInRole
      UsersInRoleGrid.DataBind()
    End If

  End Sub


  Public Sub AddUsers_OnClick(ByVal
 sender As Object, ByVal
 args As EventArgs)

    ' Verify that a role is selected.

    If RolesListBox.SelectedItem Is Nothing
 Then
      Msg.Text = "Please select a role."
      Return
    End If


    ' Verify that at least one user is selected.

    If UsersListBox.SelectedItem Is Nothing
 Then
      Msg.Text = "Please select one or more users."
      Return
    End If


    ' Create list of users to be added to the selected role.

    Dim newusers(UsersListBox.GetSelectedIndices().Length - 1)
 As String

    For i As Integer = 0
 To newusers.Length - 1
      newusers(i) = UsersListBox.Items(UsersListBox.GetSelectedIndices(i)).Value
    Next


    ' Add the users to the selected role.

    Try
      Roles.AddUsersToRole(newusers, RolesListBox.SelectedItem.Value)

      ' Re-bind users in role to GridView.

      usersInRole = Roles.GetUsersInRole(RolesListBox.SelectedItem.Value)
      UsersInRoleGrid.DataSource = usersInRole
      UsersInRoleGrid.DataBind()
    Catch e As Exception
      Msg.Text = e.Message
    End Try

  End Sub


  Public Sub UsersInRoleGrid_RemoveFromRole(ByVal
 sender As Object, ByVal
 args As GridViewCommandEventArgs)

    ' Get the selected user name to remove.

    Dim index As Integer
 = Convert.ToInt32(args.CommandArgument)

    Dim username As String
 = (CType(UsersInRoleGrid.Rows(index).Cells(0).Controls(0), DataBoundLiteralControl)).Text


    ' Remove the user from the selected role.

    Try
      Roles.RemoveUserFromRole(username, RolesListBox.SelectedItem.Value)
    Catch e As Exception
      Msg.Text = "An exception of type " & e.GetType().ToString()
 & _
                 " was encountered removing the user from the
 role."
    End Try

    ' Re-bind users in role to GridView.

    usersInRole = Roles.GetUsersInRole(RolesListBox.SelectedItem.Value)
    UsersInRoleGrid.DataSource = usersInRole
    UsersInRoleGrid.DataBind()

  End Sub



</script>

<html>
<head>
  <title>Sample: Role Membership</title>
</head>
<body>
  <form runat="server" id="PageForm">
    <h3>
      Role Membership</h3>
    <asp:Label ID="Msg" ForeColor="maroon"
 runat="server" /><br>
    <table cellpadding="3" border="0">
      <tr>
        <td valign="top">
          Roles:</td>
        <td valign="top">
          <asp:ListBox ID="RolesListBox" runat="server"
 Rows="8" AutoPostBack="true"
 /></td>
        <td valign="top">
          Users:</td>
        <td valign="top">
          <asp:ListBox ID="UsersListBox" DataTextField="Username"
 Rows="8" SelectionMode="Multiple"
            runat="server" /></td>
        <td valign="top">
          <asp:Button Text="Add User(s) to Role"
 ID="AddUsersButton" runat="server"
 OnClick="AddUsers_OnClick" /></td>
      </tr>
      <tr>
        <td valign="top">
          Users In Role:</td>
        <td valign="top">
          <asp:GridView runat="server" CellPadding="4"
 ID="UsersInRoleGrid" AutoGenerateColumns="false"
            GridLines="None" CellSpacing="0"
 OnRowCommand="UsersInRoleGrid_RemoveFromRole">
            <HeaderStyle BackColor="navy" ForeColor="white"
 />
            <Columns>
              <asp:TemplateField HeaderText="User Name"
 runat="server">
                <ItemTemplate>
                  <%# Container.DataItem.ToString() %>
                </ItemTemplate>
              </asp:TemplateField>
              <asp:ButtonField runat="server" Text="Remove
 From Role" ButtonType="Link" />
            </Columns>
          </asp:GridView>
        </td>
      </tr>
    </table>
  </form>
</body>
</html>

<%@ Page Language="C#" %>

<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Web.UI" %>

<script runat="server">

  string[] rolesArray;
  MembershipUserCollection users;
  string[] usersInRole;

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

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

      rolesArray = Roles.GetAllRoles();
      RolesListBox.DataSource = rolesArray;
      RolesListBox.DataBind();

      // Bind users to ListBox.

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

    if (RolesListBox.SelectedItem != null)
    {
      // Show users in role. Bind user list to GridView.

      usersInRole = Roles.GetUsersInRole(RolesListBox.SelectedItem.Value);
      UsersInRoleGrid.DataSource = usersInRole;
      UsersInRoleGrid.DataBind();
    }
  }


  public void AddUsers_OnClick(object sender,
 EventArgs args)
  {
    // Verify that a role is selected.

    if (RolesListBox.SelectedItem == null)
    {
      Msg.Text = "Please select a role.";
      return;
    }


    // Verify that at least one user is selected.

    if (UsersListBox.SelectedItem == null)
    {
      Msg.Text = "Please select one or more users.";
      return;
    }


    // Create list of users to be added to the selected role.

    string[] newusers = new string[UsersListBox.GetSelectedIndices().Length];

    for (int i = 0; i < newusers.Length;
 i++)
    {
      newusers[i] = UsersListBox.Items[UsersListBox.GetSelectedIndices()[i]].Value;
    }


    // Add the users to the selected role.

    try
    {
      Roles.AddUsersToRole(newusers, RolesListBox.SelectedItem.Value);

      // Re-bind users in role to GridView.

      usersInRole = Roles.GetUsersInRole(RolesListBox.SelectedItem.Value);
      UsersInRoleGrid.DataSource = usersInRole;
      UsersInRoleGrid.DataBind();
    }
    catch (Exception e)
    {
      Msg.Text = e.Message;
    }
  }


  public void UsersInRoleGrid_RemoveFromRole(object
 sender, GridViewCommandEventArgs args)
  {
    // Get the selected user name to remove.

    int index = Convert.ToInt32(args.CommandArgument);

    string username = ((DataBoundLiteralControl)UsersInRoleGrid.Rows[index].Cells[0].Controls[0]).Text;


    // Remove the user from the selected role.

    try
    {
      Roles.RemoveUserFromRole(username, RolesListBox.SelectedItem.Value);
    }
    catch (Exception e)
    {
      Msg.Text = "An exception of type " + e.GetType().ToString() +
                 " was encountered removing the user from the role.";
    }


    // Re-bind users in role to GridView.

    usersInRole = Roles.GetUsersInRole(RolesListBox.SelectedItem.Value);
    UsersInRoleGrid.DataSource = usersInRole;
    UsersInRoleGrid.DataBind();
  }



</script>

<html>
<head>
  <title>Sample: Role Membership</title>
</head>
<body>
  <form runat="server" id="PageForm">
    <h3>
      Role Membership</h3>
    <asp:Label ID="Msg" ForeColor="maroon" runat="server"
 /><br>
    <table cellpadding="3" border="0">
      <tr>
        <td valign="top">
          Roles:</td>
        <td valign="top">
          <asp:ListBox ID="RolesListBox" runat="server" Rows="8"
 AutoPostBack="true" /></td>
        <td valign="top">
          Users:</td>
        <td valign="top">
          <asp:ListBox ID="UsersListBox" DataTextField="Username"
 Rows="8" SelectionMode="Multiple"
            runat="server" /></td>
        <td valign="top">
          <asp:Button Text="Add User(s) to Role" ID="AddUsersButton"
 runat="server" OnClick="AddUsers_OnClick" /></td>
      </tr>
      <tr>
        <td valign="top">
          Users In Role:</td>
        <td valign="top">
          <asp:GridView runat="server" CellPadding="4" ID="UsersInRoleGrid"
 AutoGenerateColumns="false"
            GridLines="None" CellSpacing="0" OnRowCommand="UsersInRoleGrid_RemoveFromRole">
            <HeaderStyle BackColor="navy" ForeColor="white"
 />
            <Columns>
              <asp:TemplateField HeaderText="User Name" runat="server">
                <ItemTemplate>
                  <%# Container.DataItem.ToString() %>
                </ItemTemplate>
              </asp:TemplateField>
              <asp:ButtonField runat="server" Text="Remove From
 Role" ButtonType="Link" />
            </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

参照

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

このページでは「.NET Framework クラスライブラリリファレンス」からSqlRoleProvider.AddUsersToRoles メソッドを検索した結果を表示しています。
Weblioに収録されているすべての辞書からSqlRoleProvider.AddUsersToRoles メソッドを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からSqlRoleProvider.AddUsersToRoles メソッドを検索

>> 「SqlRoleProvider.AddUsersToRoles メソッド」を含む用語の索引
SqlRoleProvider.AddUsersToRoles メソッドのページへのリンク


	© 2025 Microsoft.All rights reserved.

SqlRoleProvider.AddUsersToRoles メソッドとは？ わかりやすく解説

SqlRoleProvider.AddUsersToRoles メソッド

急上昇のことば

SqlRoleProvider.AddUsersToRoles メソッドとは？わかりやすく解説