RoleProvider.RemoveUsersFromRoles(String[], String[]) RoleProvider.RemoveUsersFromRoles(String[], String[]) RoleProvider.RemoveUsersFromRoles(String[], String[]) RoleProvider.RemoveUsersFromRoles(String[], String[]) Method

Definition

Removes the specified user names from the specified roles for the configured applicationName.

public:
 abstract void RemoveUsersFromRoles(cli::array <System::String ^> ^ usernames, cli::array <System::String ^> ^ roleNames);
public abstract void RemoveUsersFromRoles (string[] usernames, string[] roleNames);
abstract member RemoveUsersFromRoles : string[] * string[] -> unit
Public MustOverride Sub RemoveUsersFromRoles (usernames As String(), roleNames As String())

Parameters

usernames
String[]

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

roleNames
String[]

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

Examples

The following code example shows a sample implementation of the RemoveUsersFromRoles method.

public override void RemoveUsersFromRoles(string[] usernames, string[] rolenames)
{
  foreach (string rolename in rolenames)
  {
    if (rolename == null || rolename == "")
      throw new ProviderException("Role name cannot be empty or null.");
    if (!RoleExists(rolename))
      throw new ProviderException("Role name not found.");
  }

  foreach (string username in usernames)
  {
    if (username == null || username == "")
      throw new ProviderException("User name cannot be empty or null.");

    foreach (string rolename in rolenames)
    {
      if (!IsUserInRole(username, rolename))
        throw new ProviderException("User is not in role.");
    }
  }


  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("DELETE FROM UsersInRoles "  +
                                    " WHERE Username = ? AND Rolename = ? AND ApplicationName = ?", conn);

  OdbcParameter userParm = cmd.Parameters.Add("@Username", OdbcType.VarChar, 255);
  OdbcParameter roleParm = cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255);
  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;

  try
  {
    conn.Open();

    foreach (string username in usernames)
    {
      foreach (string rolename in rolenames)
      {
        userParm.Value = username;
        roleParm.Value = rolename;
        cmd.ExecuteNonQuery();
      }
    }
  }
  catch (OdbcException)
  {
    // Handle exception.
  }
  finally
  {
    conn.Close();      
  }
}
Public Overrides Sub RemoveUsersFromRoles(ByVal usernames As String(), ByVal rolenames As String())

    For Each rolename As String In rolenames
        If rolename Is Nothing OrElse rolename = "" Then _
          Throw New ProviderException("Role name cannot be empty or null.")
        If Not RoleExists(rolename) Then _
          Throw New ProviderException("Role name not found.")
    Next

    For Each username As String In usernames
        If username Is Nothing OrElse username = "" Then _
          Throw New ProviderException("User name cannot be empty or null.")

        For Each rolename As String In rolenames
            If Not IsUserInRole(username, rolename) Then
                Throw New ProviderException("User is not in role.")
            End If
        Next
    Next

    Dim conn As OdbcConnection = New OdbcConnection(connectionString)
    Dim cmd As OdbcCommand = New OdbcCommand("DELETE FROM UsersInRoles " & _
                                             " WHERE Username = ? AND Rolename = ? AND ApplicationName = ?", conn)

    Dim userParm As OdbcParameter = cmd.Parameters.Add("@Username", OdbcType.VarChar, 255)
    Dim roleParm As OdbcParameter = cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255)
    cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName

    Try
        conn.Open()

        For Each username As String In usernames
            For Each rolename As String In rolenames
                userParm.Value = username
                roleParm.Value = rolename
                cmd.ExecuteNonQuery()
            Next
        Next
    Catch e As OdbcException
        ' Handle exception.
    Finally
        conn.Close()
    End Try
End Sub

Remarks

RemoveUsersFromRoles is called by RemoveUserFromRole , RemoveUsersFromRole , RemoveUserFromRoles , and RemoveUsersFromRoles methods of the Roles class to remove the specified users from the specified roles at the data source. Only roles for the configured ApplicationName are modified.

If any of the specified role names are not found for the configured applicationName, we recommend that your provider throw a ProviderException.

If any of the specified user names are not associated with any of the specified role names for the configured applicationName, we recommend that your provider throw a ProviderException.

If any of the specified user names is null or is an empty string, we recommend that your provider throw an exception.

If any of the specified role names is null or is an empty string, we recommend that your provider throw an exception.

If your data source supports transactions, we recommend that you include each remove operation in a transaction and that you roll back the transaction and throw an exception if any remove operation fails.

Applies to

See also