This documentation is archived and is not being maintained.

AuthorizationStoreRoleProvider::DeleteRole Method

Removes a role from the authorization-manager policy store.

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 deleted; otherwise, false.

ExceptionCondition
System::ArgumentNullException

roleName is nullptr.

System::ArgumentException

roleName is an empty string.

-or-

roleName contains a comma.

System.Configuration.Provider::ProviderException

roleName has one or more members and throwOnPopulatedRole is true.

-or-

The configured applicationName was not found.

-or-

The configured scopeName was not found.

-or-

The authorization-manager runtime is not installed on the server.

System.IO::FileNotFoundException

The connectionStringName attribute references a connection string to a file that does not exist.

HttpException

The AuthorizationStoreRoleProvider instance is configured with a file-based policy store, and read access to the file is not allowed at the current trust level.

The DeleteRole method is called by the Roles class to delete a role from the authorization-manager policy store 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 policy store. 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 authorization-manager policy store. For an example of a Web.config file that enables role management, see AuthorizationStoreRoleProvider.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: