This documentation is archived and is not being maintained.

SqlRoleProvider::DeleteRole Method

Removes a role from the role database.

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

public:
virtual bool DeleteRole(
	String^ roleName, 
	bool throwOnPopulatedRole
) override

Parameters

roleName
Type: System::String

The name of the role to delete.

throwOnPopulatedRole
Type: System::Boolean

If true, throws an exception if roleName has one or more members.

Return Value

Type: System::Boolean
true if the role was successfully deleted; otherwise, false.

ExceptionCondition
System::ArgumentNullException

roleName is nullptr (Nothing in Visual Basic).

System::ArgumentException

roleName is an empty string or contains a comma.

-or-

roleName is longer than 256 characters.

System.Configuration.Provider::ProviderException

roleName has one or more members and throwOnPopulatedRole is true.

-or-

An unknown error occurred while communicating with the database.

The DeleteRole method is called by the Roles class to delete a role from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). When a role is deleted, the list of users associated with that role is also deleted from the database. The user information in the database is not affected.

If throwOnPopulatedRole is true, then an exception will be thrown and the role will not be deleted if the role identified by the roleName parameter has one or more members. If throwOnPopulatedRole is false, then the role will be deleted whether it is empty or not.

The following example deletes a role from the database. For an example of a Web.config file that enables role management, see SqlRoleProvider.

No code example is currently available or this language may not be supported.

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
Show: