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:
virtual bool DeleteRole(
	String^ roleName, 
	bool throwOnPopulatedRole
) abstract

Parameters

roleName
Type: System::String

The name of the role to delete.

throwOnPopulatedRole
Type: System::Boolean

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

Return Value

Type: System::Boolean
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, is nullptr, or is an empty string, we recommend that your provider throw an exception.

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

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: