Skip to main content
.NET Framework Class Library
RolesRemoveUsersFromRoles Method

Removes the specified user names from the specified roles.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)
Syntax
Public Shared Sub RemoveUsersFromRoles ( _
	usernames As [%$TOPIC/7e1c4dda_en-us_VS_110_1_0_0_0_0%](), _
	roleNames As [%$TOPIC/7e1c4dda_en-us_VS_110_1_0_0_0_1%]() _
)
public static void RemoveUsersFromRoles(
	[%$TOPIC/7e1c4dda_en-us_VS_110_1_0_1_0_0%][] usernames,
	[%$TOPIC/7e1c4dda_en-us_VS_110_1_0_1_0_1%][] roleNames
)
public:
static void RemoveUsersFromRoles(
	array<[%$TOPIC/7e1c4dda_en-us_VS_110_1_0_2_0_0%]^>^ usernames, 
	array<[%$TOPIC/7e1c4dda_en-us_VS_110_1_0_2_0_1%]^>^ roleNames
)
static member RemoveUsersFromRoles : 
        usernames:[%$TOPIC/7e1c4dda_en-us_VS_110_1_0_3_0_0%][] * 
        roleNames:[%$TOPIC/7e1c4dda_en-us_VS_110_1_0_3_0_1%][] -> unit
public static function RemoveUsersFromRoles(
	usernames : [%$TOPIC/7e1c4dda_en-us_VS_110_1_0_4_0_0%][], 
	roleNames : [%$TOPIC/7e1c4dda_en-us_VS_110_1_0_4_0_1%][]
)

Parameters

usernames
Type: SystemString

A string array of user names to remove from the specified roles.

roleNames
Type: SystemString

A string array of role names to remove the specified users from.

Exceptions
ExceptionCondition
SystemArgumentNullException

One of the roles specified in roleNames is .

-or-

One of the users specified in usernames is .

SystemArgumentException

One of the roles specified in roleNames is an empty string or contains a comma (,).

-or-

One of the users specified in usernames is an empty string or contains a comma (,).

-or-

roleNames contains a duplicate element.

-or-

usernames contains a duplicate element.

System.Configuration.ProviderProviderException

Role management is not enabled.

Remarks

The RemoveUsersFromRoles method calls the default role provider to remove the specified users from the specified roles at the data source.

If the application uses the SqlRoleProvider class, the database updates that are performed during the call to the RemoveUsersFromRoles method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed.

Examples

The following code example uses the RemoveUsersFromRoles method to remove one or more users from one or more roles based on user input. 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 RemoveUsers_OnClick(sender As Object, args As EventArgs)

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

  Dim user_indices() As Integer = UsersListBox.GetSelectedIndices()

  If user_indices.Length = 0 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 users to be removed from the selected roles.

  Dim usersList(user_indices.Length - 1) As String

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


  ' Create list of roles to be remove the selected users from.

  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


  ' Remove the users from the selected roles.

  Try
    Roles.RemoveUsersFromRoles(usersList, rolesList)  
    Msg.Text = "User(s) removed from 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" SelectionMode="Multiple" runat="server" /></td>
      <td valign="top"><asp:Button Text="Remove User(s) from Role(s)" id="RemoveUsersButton"
                                 runat="server" OnClick="RemoveUsers_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 RemoveUsers_OnClick(object sender, EventArgs args)
{
  // Verify that at least one user and one role are selected.

  int[] user_indices = UsersListBox.GetSelectedIndices();

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

  int[] role_indices = RolesListBox.GetSelectedIndices();

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


  // Create list of users to be removed from the selected roles.

  string[] usersList = new string[user_indices.Length];

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


  // Create list of roles to be remove the selected users from.

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

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


  // Remove the users from the selected roles.

  try
  {
    Roles.RemoveUsersFromRoles(usersList, rolesList);  
    Msg.Text = "User(s) removed from 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" SelectionMode="Multiple" runat="server" /></td>
      <td valign="top"><asp:Button Text="Remove User(s) from Role(s)" id="RemoveUsersButton"
                                 runat="server" OnClick="RemoveUsers_OnClick" /></td>
    </tr>
  </table>
</form>

</body>
</html>
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0