SqlMembershipProvider.DeleteUser(String, Boolean) メソッド

  • リファレンス

定義

名前空間:
System.Web.Security
アセンブリ:
System.Web.dll

SQL Server メンバーシップ データベースからユーザーのメンバーシップ情報を削除します。

public:
 override bool DeleteUser(System::String ^ username, bool deleteAllRelatedData);
public override bool DeleteUser (string username, bool deleteAllRelatedData);
override this.DeleteUser : string * bool -> bool
Public Overrides Function DeleteUser (username As String, deleteAllRelatedData As Boolean) As Boolean

パラメーター

username
String

削除するユーザーの名前。

deleteAllRelatedData
Boolean

データベースからユーザーに関連するデータを削除するには true。データベース内のユーザーに関連するデータをそのままにするには false。

戻り値

Boolean

ユーザーが削除された場合は true。それ以外の場合は false。 ユーザーがデータベース内に存在しない場合にも false 値が戻ります。

例外

ArgumentException

username が空の文字列 ("") であるか、コンマを含んでいるか、または 256 文字を超えています。

ArgumentNullException

username が nullです。

例

次のコード例では、現在ログオンしているユーザーを削除します。

Note

この例では、 を使用 SqlMembershipProvider して、指定した を SqlMembershipProvider Web.config ファイル内の として defaultProvider 呼び出します。 型SqlMembershipProviderとして既定のプロバイダーにアクセスする必要がある場合は、 クラスの プロパティをProviderMembershipキャストできます。 特定のプロバイダーの種類として他の構成済みプロバイダーにアクセスするには、 クラスの プロパティを使用して構成された名前で Providers アクセスし、特定のプロバイダーの Membership 種類としてキャストします。

<%@ 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>

注釈

このメソッドは、 クラスによって呼び出されMembership、ASP.NET アプリケーションの構成ファイルで指定されたSQL Server データベースからユーザーを削除します。

削除されたユーザーは、構成された ApplicationNameからしか削除されません。

が にtrue設定されている場合deleteAllRelatedData、または WebPart 個人用設定機能のRolesProfileデータベースに格納されているすべてのユーザー データも、構成された ApplicationNameに対して削除されます。

メンバーシップ ユーザーがデータベースに存在せず、 が trueの場合、deleteAllRelatedDataプロパティで指定されたApplicationNameアプリケーションに対Rolesして、関連データと、、Profile、またはWebPart個人用設定機能に格納されているユーザー情報は削除されます。 その結果、 メソッドを DeleteUser 使用すると、認証されたユーザー情報を格納するためにオブジェクトが使用されていない場合 SqlMembershipProvider でも、ユーザーに関連する情報をすばやく削除できます。

username パラメーター値の先頭と末尾の空白はトリムされます。

適用対象

こちらもご覧ください