This documentation is archived and is not being maintained.

RoleProvider.DeleteRole Method

Removes a role from the data source for the configured applicationName.

Namespace: System.Web.Security
Assembly: System.Web (in system.web.dll)

public abstract bool DeleteRole (
	string roleName,
	bool throwOnPopulatedRole
public abstract boolean DeleteRole (
	String roleName, 
	boolean throwOnPopulatedRole
public abstract function DeleteRole (
	roleName : String, 
	throwOnPopulatedRole : boolean
) : boolean
Not applicable.



The name of the role to delete.


If true, throw an exception if roleName has one or more members and do not delete roleName.

Return Value

true if the role was successfully deleted; otherwise, false.

DeleteRole is called by the DeleteRole and the DeleteRole methods of the Roles class to delete the specified role from the data source for the configured ApplicationName.

When you delete a role from the data source, ensure that you also delete any associations between a user name and the deleted role for the configured applicationName.

If throwOnPopulatedRole is true, and the role identified by the roleName parameter has one or more members, throw a ProviderException and do not delete the role. If throwOnPopulatedRole is false, then delete the role whether it is empty or not.

If the specified role name does not exist or if it is a null reference (Nothing in Visual Basic) or an empty string, we recommend that your provider throw an exception.

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

public override bool DeleteRole(string rolename, bool throwOnPopulatedRole)
  if (!RoleExists(rolename))
    throw new ProviderException("Role does not exist.");

  if (throwOnPopulatedRole && GetUsersInRole(rolename).Length > 0)
    throw new ProviderException("Cannot delete a populated role.");

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

  cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename;
  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;

  OdbcCommand cmd2 = new OdbcCommand("DELETE FROM UsersInRoles "  +
                                     " WHERE Rolename = ? AND ApplicationName = ?", conn);

  cmd2.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename;
  cmd2.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;


  catch (OdbcException)
    // Handle exception.

    return false;

  return true;

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0