Roles.AddUserToRoles Method
Adds the specified user to the specified roles.
Assembly: System.Web (in System.Web.dll)
'Declaration Public Shared Sub AddUserToRoles ( _ username As String, _ roleNames As String() _ )
Parameters
- username
- Type: System.String
The user name to add to the specified roles.
- roleNames
- Type: System.String()
A string array of roles to add the specified user name to.
| Exception | Condition |
|---|---|
| System.ArgumentNullException | One of the roles in roleNames is Nothing. -or- username is Nothing. |
| System.ArgumentException | One of the roles in roleNames is an empty string or contains a comma (,). -or- username is an empty string or contains a comma (,). -or- roleNames contains a duplicate element. |
| System.Configuration.Provider.ProviderException | Role management is not enabled. |
The AddUserToRoles method calls the default role provider to associate the specified user with the specified roles at the data source.
If your application uses the SqlRoleProvider class, the database updates that are performed during the call to the AddUserToRoles method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed.
Note |
|---|
User names and role names cannot contain commas. |
The following code example adds a user to one or more roles. For an example of a Web.config file that enables role management, see Roles.
<%@ 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>
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note