MembershipProvider.DeleteUser(String, Boolean) Method

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Assembly:: System.Web.ApplicationServices.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes a user from the membership data source.

public:
 abstract bool DeleteUser(System::String ^ username, bool deleteAllRelatedData);

public abstract bool DeleteUser (string username, bool deleteAllRelatedData);

abstract member DeleteUser : string * bool -> bool

Public MustOverride Function DeleteUser (username As String, deleteAllRelatedData As Boolean) As Boolean

Parameters

username: String

The name of the user to delete.

deleteAllRelatedData: Boolean

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

Returns

Boolean

true if the user was successfully deleted; otherwise, false.

Examples

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

Remarks

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.

Applies to

Dela via