Membership.DeleteUser Method
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.
Deletes a user from the database.
| DeleteUser(String) |
Deletes a user and any related user data from the database. |
| DeleteUser(String, Boolean) |
Deletes a user from the database. |
Deletes a user and any related user data from the database.
public:
static bool DeleteUser(System::String ^ username);public static bool DeleteUser(string username);static member DeleteUser : string -> boolPublic Shared Function DeleteUser (username As String) As BooleanParameters
- username
- String
The name of the user to delete.
Returns
true if the user was deleted; otherwise, false.
Exceptions
username is an empty string or contains a comma (,).
username is null.
Examples
The following code example deletes the currently logged-on user and all related data.
<%@ 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);
Response.Redirect("logincs.aspx");
}
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 />
<p style="color:red">Are you sure you want to delete the userid <b><%=User.Identity.Name%></b>?</p>
<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>
<%@ 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(sender As Object, args As EventArgs)
Membership.DeleteUser(User.Identity.Name)
Response.Redirect("loginvb.aspx")
End Sub
Public Sub CancelButton_OnClick(sender As Object, 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>
<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>
Remarks
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.
See also
Applies to
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
Deletes a user from the database.
public:
static bool DeleteUser(System::String ^ username, bool deleteAllRelatedData);public static bool DeleteUser(string username, bool deleteAllRelatedData);static member DeleteUser : string * bool -> boolPublic Shared Function DeleteUser (username As String, deleteAllRelatedData As Boolean) As BooleanParameters
- 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
true if the user was deleted; otherwise, false.
Exceptions
username is an empty string or contains a comma (,).
username is null.
Examples
The following code example deletes the currently logged-on user and all related data.
<%@ 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>
<%@ 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>
Remarks
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.
See also
Applies to
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: