Roles.AddUserToRoles(String, String[]) Méthode

Référence

Définition

Espace de noms:: System.Web.Security

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Ajoute l'utilisateur spécifié aux rôles spécifiés.

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

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

static member AddUserToRoles : string * string[] -> unit

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

Paramètres

username: String

Nom de l'utilisateur à ajouter aux rôles spécifiés.

roleNames: String[]

Tableau de chaînes contenant le nom de l'utilisateur à ajouter aux rôles.

Exceptions

ArgumentNullException

Un des rôles dans roleNames est null.

- ou -

username a la valeur null.

ArgumentException

Un des rôles dans roleNames est une chaîne vide ou contient une virgule (,).

- ou -

username est une chaîne vide ou contient une virgule (,).

- ou -

roleNames contient un élément en double.

ProviderException

La gestion des rôles n'est pas activée.

Exemples

L’exemple de code suivant ajoute un utilisateur à un ou plusieurs rôles. Pour obtenir un exemple de fichier Web.config qui active la gestion des rôles, consultez Roles.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Web.UI" %>
<!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;
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 xmlns="http://www.w3.org/1999/xhtml" >
<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="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Web.UI" %>
<!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
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 xmlns="http://www.w3.org/1999/xhtml" >
<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>

Remarques

La AddUserToRoles méthode appelle le fournisseur de rôles par défaut pour associer l’utilisateur spécifié aux rôles spécifiés au niveau de la source de données.

Si votre application utilise la SqlRoleProvider classe , les mises à jour de base de données qui sont effectuées pendant l’appel à la AddUserToRoles méthode sont effectuées dans une transaction. Si une erreur est rencontrée, telle qu’un nom d’utilisateur qui se trouve déjà dans un rôle spécifié, la transaction est restaurée et aucune mise à jour n’est effectuée.

Notes

Les noms d’utilisateur et de rôle ne peuvent pas contenir de virgules.

S’applique à

Voir aussi

Présentation de la gestion des rôles ASP.NET

Partager via

Roles.AddUserToRoles(String, String[]) Méthode

Définition

Paramètres

Exceptions

Exemples

Remarques

S’applique à

Voir aussi

Commentaires

Ressources supplémentaires