This documentation is archived and is not being maintained.

MembershipProvider.DeleteUser Method

Removes a user from the membership data source.

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

'Declaration
Public MustOverride Function DeleteUser ( _
	username As String, _
	deleteAllRelatedData As Boolean _
) As Boolean
'Usage
Dim instance As MembershipProvider 
Dim username As String 
Dim deleteAllRelatedData As Boolean 
Dim returnValue As Boolean 

returnValue = instance.DeleteUser(username, _
	deleteAllRelatedData)

Parameters

username
Type: System.String

The name of the user to delete.

deleteAllRelatedData
Type: System.Boolean

true to delete data related to the user from the database; false to leave data related to the user in the database.

Return Value

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

Takes, as input, the name of a user and deletes that user's information from the data source. If deleteAllRelatedData is true, then all user data stored in the database for the Roles, Profile, and WebPart personalization is also deleted.

For an example of a MembershipProvider implementation, see Implementing a Profile Provider.

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: