Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ActiveDirectoryMembershipProvider.DeleteUser Method

Removes a user's membership information from the Active Directory data store.

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)
[DirectoryServicesPermissionAttribute(SecurityAction.Demand, Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.Assert, Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.InheritanceDemand, Unrestricted = true)]
public override bool DeleteUser(
	string username,
	bool deleteAllRelatedData
)

Parameters

username
Type: System.String
The name of the user to delete.
deleteAllRelatedData
Type: System.Boolean
This parameter is ignored by the DeleteUser method.

Return Value

Type: System.Boolean
true if the user was deleted; otherwise, false if the user was not found in the data store.
ExceptionCondition
ArgumentException

username is empty, or exceeds the maximum length for the user name (usually 256 characters).

- or -

username contains commas.

- or -

The user name is mapped to the userPrincipalName attribute and the userName parameter contains backslashes.

ArgumentNullException

username is null.

COMException

An error occurred while attempting to delete the user.

InvalidOperationException

The DeleteUser method is called before the ActiveDirectoryMembershipProvider instance is initialized.

The DeleteUser method immediately removes the user identified by the username parameter. Since the Active Directory data store does not store user information in separate areas of the directory, the deleteAllRelatedData parameter is ignored, although it must be set to either true or false when calling the DeleteUser method.

The ActiveDirectoryMembershipProvider class finds the user instance to delete by performing a single-level search for the user name in the users container determined by the connection string. See the ActiveDirectoryMembershipProvider class topic for more information about connection strings.

username must be 64 characters or less.

Security noteSecurity Note

You cannot delete users unless the credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "delete child instances" access right.

.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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.