Redigera

Dela via


Roles.RemoveUserFromRoles(String, String[]) Method

Definition

Removes the specified user from the specified roles.

public:
 static void RemoveUserFromRoles(System::String ^ username, cli::array <System::String ^> ^ roleNames);
public static void RemoveUserFromRoles (string username, string[] roleNames);
static member RemoveUserFromRoles : string * string[] -> unit
Public Shared Sub RemoveUserFromRoles (username As String, roleNames As String())

Parameters

username
String

The user to remove from the specified roles.

roleNames
String[]

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

Exceptions

One of the roles in roleNames is null.

-or-

username is null.

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.

Role management is not enabled.

Examples

The following code example uses the RemoveUserFromRoles method to remove a user from one or more roles. For an example of a Web.config file that enables role management, see 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.

    users = Membership.GetAllUsers();
    UsersListBox.DataSource = users;
    UsersListBox.DataBind();
  }
}

public void UsersListBox_OnSelectedIndexChanged(object sender, EventArgs args)
{
  // Bind users to ListBox.

  rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value);
  RolesListBox.DataSource = rolesArray;
  RolesListBox.DataBind();
}

public void RemoveUser_OnClick(object sender, EventArgs args)
{
  // Verify that at least a user and at least one role are 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 remove the selected user 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 user to the selected roles.

  try
  {
    Roles.RemoveUserFromRoles(UsersListBox.SelectedItem.Value, rolesList);  
    Msg.Text = "User removed from Role(s).";

    // Rebind roles to ListBox.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value);
    RolesListBox.DataSource = rolesArray;
    RolesListBox.DataBind();
  }
  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">Users:</td>
      <td valign="top"><asp:ListBox id="UsersListBox" Rows="8" DataTextField="Username" 
                                    OnSelectedIndexChanged="UsersListBox_OnSelectedIndexChanged" 
                                    AutoPostBack="true" runat="server" /></td>
      <td valign="top">Roles:</td>
      <td valign="top"><asp:ListBox id="RolesListBox" SelectionMode="Multiple" 
                                    runat="server" Rows="8" /></td>
      <td valign="top"><asp:Button Text="Remove User from Roles" id="RemoveUserButton"
                                   runat="server" OnClick="RemoveUser_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.

    users = Membership.GetAllUsers()
    UsersListBox.DataSource = users
    UsersListBox.DataBind()
  End If
End Sub

Public Sub UsersListBox_OnSelectedIndexChanged(sender As Object, args As EventArgs)
  ' Bind users to ListBox.

  rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value)
  RolesListBox.DataSource = rolesArray
  RolesListBox.DataBind()
End Sub

Public Sub RemoveUser_OnClick(sender As Object, args As EventArgs)
  ' Verify that at least a user and at least one role are selected.

  If UsersListBox.SelectedItem Is Nothing Then
    Msg.Text = "Please select a user."
    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 remove the selected user 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 user to the selected roles.

  Try
    Roles.RemoveUserFromRoles(UsersListBox.SelectedItem.Value, rolesList)  
    Msg.Text = "User removed from Role(s)."

    ' Rebind roles to ListBox.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value)
    RolesListBox.DataSource = rolesArray
    RolesListBox.DataBind()
  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">Users:</td>
      <td valign="top"><asp:ListBox id="UsersListBox" Rows="8" DataTextField="Username" 
                                    OnSelectedIndexChanged="UsersListBox_OnSelectedIndexChanged" 
                                    AutoPostBack="true" runat="server" /></td>
      <td valign="top">Roles:</td>
      <td valign="top"><asp:ListBox id="RolesListBox" SelectionMode="Multiple" 
                                    runat="server" Rows="8" /></td>
      <td valign="top"><asp:Button Text="Remove User from Roles" id="RemoveUserButton"
                                   runat="server" OnClick="RemoveUser_OnClick" /></td>
    </tr>
  </table>
</form>

</body>
</html>

Remarks

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

If the application is configured to use the SqlRoleProvider class, the database updates that are performed during the call to the RemoveUserFromRoles 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.

Applies to

See also