Adds the specified user to the specified roles.
(in System.Web.dll)
Visual Basic (Declaration)
Public Shared Sub AddUserToRoles ( _
username As String, _
roleNames As String() _
)
Dim username As String
Dim roleNames As String()
Roles.AddUserToRoles(username, roleNames)
public static void AddUserToRoles(
string username,
string[] roleNames
)
public:
static void AddUserToRoles(
String^ username,
array<String^>^ roleNames
)
public static function AddUserToRoles(
username : String,
roleNames : String[]
)
Parameters
- username
- Type: System..::.String
The user name to add to the specified roles.
- roleNames
- Type: array<System..::.String>[]()[]
A string array of roles to add the specified user name to.
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.
.gif) 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 Exception
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" %>
<!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 >
<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, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference
Other Resources