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

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

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

Roles.AddUserToRoles メソッド

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

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

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

Visual Basic (宣言)

Public Shared Sub AddUserToRoles
 ( _
    username As String, _
    roleNames As String() _
)

Visual Basic (使用法)

Dim username As String
Dim roleNames As String()

Roles.AddUserToRoles(username, roleNames)

public static void AddUserToRoles
 (
    string username,
    string[] roleNames
)

C++

public:
static void AddUserToRoles (
    String^ username, 
    array<String^>^ roleNames
)

public static void AddUserToRoles
 (
    String username, 
    String[] roleNames
)

JScript

public static function AddUserToRoles
 (
    username : String, 
    roleNames : String[]
)

パラメータ

username: 指定されたロールに追加するユーザー名。

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

例外

例外の種類	条件
System.ArgumentNullException	roleNames のロールの 1 つは、null 参照 (Visual Basic では Nothing) です。または username が null 参照 (Visual Basic では Nothing) です。
System.ArgumentException	roleNames のロールの 1 つが空の文字列か、またはコンマ (,) を含んでいます。または username が空の文字列であるか、またはコンマ (,) を含んでいます。または roleNames に重複した要素が含まれています。
System.Configuration.Provider.ProviderException	ロール管理は有効になっていません。

例外の種類

条件

System.ArgumentNullException

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

または

username が null 参照 (Visual Basic では Nothing) です。

System.ArgumentException

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

または

username が空の文字列であるか、またはコンマ (,) を含んでいます。

または

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

System.Configuration.Provider.ProviderException

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

解説

AddUserToRoles メソッドは既定のロールプロバイダを呼び出し、指定されたユーザーをデータソースの指定されたロールに関連付けます。

アプリケーションが SqlRoleProvider クラスを使用する場合、AddUserToRoles メソッドの呼び出しによって実行されるデータベースの更新は単一のトランザクションで完了します。指定されたロールに既にユーザー名が存在するなどのエラーが発生した場合、トランザクションがロールバックされ、更新は実行されません。

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

使用例

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

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

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
End Sub


Public Sub AddUser_OnClick(sender As
 Object, args As EventArgs)

  ' Verify that a user and at least one role are selected.

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

  Dim role_indices() As Integer
 = RolesListBox.GetSelectedIndices()

  If role_indices.Length = 0 Then
    Msg.Text = "Please select one or more roles."
    Return
  End If


  ' Create list of roles to be add the selected users to.

  Dim rolesList(role_indices.Length - 1) As
 String

  For i As Integer = 0 To
 rolesList.Length - 1
    rolesList(i) = RolesListBox.Items(role_indices(i)).Value
  Next


  ' Add the users to the selected role.

  Try
    Roles.AddUserToRoles(UsersListBox.SelectedItem.Value, rolesList)
    Msg.Text = "User added to Role(s)."
  Catch e As HttpException
    Msg.Text = e.Message
  End Try
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" SelectionMode="Multiple"
                                    Rows="8" /></td>
      <td valign="top">Users:</td>
      <td valign="top"><asp:ListBox id="UsersListBox"
 DataTextField="Username" 
                                  Rows="8" runat="server"
 /></td>
      <td valign="top"><asp:Button Text="Add
 User to Role(s)" id="AddUserButton"
                                 runat="server" OnClick="AddUser_OnClick"
 /></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;

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();
  }
}


public void AddUser_OnClick(object sender,
 EventArgs args)
{
  // Verify that a user and at least one role is selected.

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

  int[] role_indices = RolesListBox.GetSelectedIndices();

  if (role_indices.Length == 0)
  {
    Msg.Text = "Please select one or more roles.";
    return;
  }


  // Create list of roles to be add the selected users to.

  string[] rolesList = new string[role_indices.Length];

  for (int i = 0; i < rolesList.Length;
 i++)
  {
    rolesList[i] = RolesListBox.Items[role_indices[i]].Value;
  }


  // Add the users to the selected role.

  try
  {
    Roles.AddUserToRoles(UsersListBox.SelectedItem.Value, rolesList);  
    Msg.Text = "User added to Role(s).";
  }
  catch (HttpException e)
  {
    Msg.Text = e.Message;
  } 
}

</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" SelectionMode="Multiple"
                                    Rows="8" /></td>
      <td valign="top">Users:</td>
      <td valign="top"><asp:ListBox id="UsersListBox"
 DataTextField="Username" 
                                  Rows="8" runat="server" /></td>
      <td valign="top"><asp:Button Text="Add User to Role(s)"
 id="AddUserButton"
                                 runat="server" OnClick="AddUser_OnClick"
 /></td>
    </tr>
  </table>
</form>

</body>
</html>