ActiveDirectoryMembershipProvider.DeleteUser メソッド

.NET Framework クラス ライブラリ リファレンス

ActiveDirectoryMembershipProvider.DeleteUser メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

Active Directory データ ストアからユーザーのメンバシップ情報を削除します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As ActiveDirectoryMembershipProvider
Dim username As String
Dim deleteAllRelatedData As Boolean
Dim returnValue As Boolean

returnValue = instance.DeleteUser(username, deleteAllRelatedData)

C#

public override bool DeleteUser (
    string username,
    bool deleteAllRelatedData
)

C++

public:
virtual bool DeleteUser (
    String^ username, 
    bool deleteAllRelatedData
) override

J#

public boolean DeleteUser (
    String username, 
    boolean deleteAllRelatedData
)

JScript

public override function DeleteUser (
    username : String, 
    deleteAllRelatedData : boolean
) : boolean

パラメータ

username

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

deleteAllRelatedData

このパラメータは DeleteUser メソッドでは無視されます。

戻り値
ユーザーが削除された場合は true。データ ストア内にユーザーが見つからなかった場合は false。

例外

例外の種類	条件
ArgumentException	username が空であるか、ユーザー名の最大長 (通常は 256 文字) を超えています。 または username はコンマを含んでいます。 または ユーザー名は userPrincipalName 属性にマップされており、userName パラメータに円記号が含まれています。
ArgumentNullException	username が null 参照 (Visual Basic では Nothing) です。
COMException	ユーザーの削除を試みているときにエラーが発生しました。
InvalidOperationException	ActiveDirectoryMembershipProvider インスタンスが初期化される前に DeleteUser メソッドが呼び出されました。

解説

DeleteUser メソッドは、username パラメータに指定されたユーザーを即座に削除します。Active Directory データ ストアではユーザー情報はディレクトリ内の別個の領域に格納されないので、deleteAllRelatedData パラメータは無視されます。ただし、DeleteUser メソッドを呼び出すときには、このパラメータを true または false に設定する必要があります。

ActiveDirectoryMembershipProvider クラスは、接続文字列により判別されたユーザー コンテナでそのユーザー名の単一レベル検索を実行することによって削除対象のユーザー インスタンスを検索します。接続文字列の詳細については、ActiveDirectoryMembershipProvider クラスのトピックを参照してください。

username は 64 文字以下にする必要があります。

セキュリティに関するメモ
Active Directory サーバーへの接続に使用する資格情報が Domain Administrator 権限を持っている (お勧めしません)、または "子インスタンスの削除" アクセス権を持っている場合にのみ、ユーザーを削除できます。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ActiveDirectoryMembershipProvider クラス
ActiveDirectoryMembershipProvider メンバ
System.Web.Security 名前空間
その他の技術情報
メンバシップの概要