This documentation is archived and is not being maintained.

Membership.DeleteUser Method (String, Boolean)

Deletes a user from the database.

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

static member DeleteUser : 
        username:string * 
        deleteAllRelatedData:bool -> bool 

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

ExceptionCondition
ArgumentException

username is an empty string or contains a comma (,).

ArgumentNullException

username is a null reference (Nothing in Visual Basic).

Users deleted from the database are only deleted from the configured applicationName.

If deleteAllRelatedData is true, user data stored in the database for the Roles, Profile, or WebPart personalization is also deleted when you are using the SqlRoleProvider, SqlProfileProvider, and SqlPersonalizationProvider objects for data storage.

The following code example deletes the currently logged-on user and all related data.

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: