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)

'Declaration
Public Overrides Function DeleteUser ( _
	username As String, _
	deleteAllRelatedData As Boolean _
) As Boolean

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. A value of false is also returned if the user does not exist in the database.

ExceptionCondition
System.ArgumentException

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

System.ArgumentNullException

username is Nothing.

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="VB" %>

<%@ 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 Sub YesButton_OnClick(ByVal sender As Object, ByVal args As EventArgs)

    Membership.DeleteUser(User.Identity.Name, DeleteRelatedData.Checked)

    FormsAuthentication.SignOut()
    FormsAuthentication.RedirectToLoginPage()

  End Sub

  Public Sub CancelButton_OnClick(ByVal sender As Object, ByVal args As EventArgs)
    Response.Redirect("default.aspx")
  End Sub

</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 />
    <p style="color:red">Are you sure you want to delete the userid <b><%=User.Identity.Name%></b>?</p>
    <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>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft