Export (0) Print
Expand All

SqlMembershipProvider.DeleteUser Method

Removes a user's membership information from the SQL Server membership database.

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

public override bool DeleteUser (
	string username,
	bool deleteAllRelatedData
)
public boolean DeleteUser (
	String username, 
	boolean deleteAllRelatedData
)
public override function DeleteUser (
	username : String, 
	deleteAllRelatedData : boolean
) : boolean
Not applicable.

Parameters

username

The name of the user to delete.

deleteAllRelatedData

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

Return Value

true if the user was deleted; otherwise, false. A value of false is also returned if the user does not exist in the database.

Exception typeCondition

System.ArgumentException

username is an empty string (""), contains a comma, or is longer than 256 characters.

System.ArgumentNullException

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

This method is called by the Membership class to remove a user from the SQL Server database specified in the ASP.NET application's configuration file.

Deleted users are only deleted from the configured ApplicationName.

If deleteAllRelatedData is set to true, then all user data stored in the database for the Roles, Profile, or WebPart personalization features is also deleted for the configured ApplicationName.

If the membership user does not exist in the database, and deleteAllRelatedData is true, then the related data and the user information stored for the Roles, Profile, or WebPart personalization features will still be deleted for the application specified in the ApplicationName property. As a result, the DeleteUser method can be used for quickly deleting information related to a user, even when the SqlMembershipProvider object is not used for storing authenticated user information.

Leading and trailing spaces are trimmed from the username parameter value.

The following code example deletes the currently logged-on user.

NoteNote:

This example uses SqlMembershipProvider to call the SqlMembershipProvider specified as the defaultProvider in the Web.config file. If you need to access the default provider as the type SqlMembershipProvider, you can cast the Provider property of the Membership class. To access other configured providers as a specific provider type, you can access them by their configured name with the Providers property of the Membership class and cast them as the specific provider type.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

public void YesButton_OnClick(object sender, EventArgs args)
{
  Membership.DeleteUser(User.Identity.Name, DeleteRelatedData.Checked);

  FormsAuthentication.SignOut();
  FormsAuthentication.RedirectToLoginPage();
}

public void CancelButton_OnClick(object sender, EventArgs args)
{
  Response.Redirect("default.aspx");
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: Delete User</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>Delete User</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <span style="color:red">Are you sure you want to delete the userid <b><%=User.Identity.Name%></b>?</span><br />

  Delete related profile and roles data: <asp:CheckBox id="DeleteRelatedData" 
                                                       checked="True" runat="Server" /><br />

  <asp:Button id="YesButton" Text="Yes" OnClick="YesButton_OnClick" runat="server" />
  <asp:Button id="CancelButton" Text="Cancel" OnClick="CancelButton_OnClick" runat="server" />
</form>

</body>
</html>

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft