DirectorySearcher クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Active Directory Domain Services に対してクエリを実行します。
public ref class DirectorySearcher : System::ComponentModel::Componentpublic class DirectorySearcher : System.ComponentModel.Component[System.DirectoryServices.DSDescription("DirectorySearcherDesc")]
public class DirectorySearcher : System.ComponentModel.Componenttype DirectorySearcher = class
inherit Component[<System.DirectoryServices.DSDescription("DirectorySearcherDesc")>]
type DirectorySearcher = class
inherit ComponentPublic Class DirectorySearcher
Inherits Component- 継承
- 属性
注釈
ライトウェイト ディレクトリ アクセス プロトコル (LDAP) を使用して Active Directory Domain Services 階層に対するクエリを検索および実行するには、 DirectorySearcher オブジェクトを使用します。 LDAP は、ディレクトリ検索をサポートする唯一のシステム提供の Active Directory サービス インターフェイス (ADSI) プロバイダーです。 管理者は、階層内にあるオブジェクトを作成、変更、および削除できます。 詳細については、「 System.DirectoryServices の使用」を参照してください。
DirectorySearcherのインスタンスを作成するときは、取得するルートと、取得するプロパティのオプションの一覧を指定します。 SearchRoot プロパティを使用すると、次のタスクを実行する追加のプロパティを設定できます。
検索結果をローカル コンピューターにキャッシュします。 CacheResults プロパティを
trueに設定して、ローカル コンピューターにディレクトリ情報を格納します。 このローカル キャッシュに対する更新が行われ、 DirectoryEntry.CommitChanges メソッドが呼び出された場合にのみ Active Directory Domain Services にコミットされます。ServerTimeLimit プロパティを使用して、検索する時間の長さを指定します。
属性名のみを取得します。 PropertyNamesOnlyプロパティを
trueに設定して、値が割り当てられている属性の名前のみを取得します。ページング検索を実行します。 ページ検索で返されるオブジェクトの最大数を指定するには、 PageSize プロパティを設定します。 ページング検索を実行しない場合は、 PageSize プロパティを既定値の 0 に設定します。
SizeLimit プロパティを使用して、返すエントリの最大数を指定します。 SizeLimit プロパティを既定値の 0 に設定すると、サーバーによって決定される既定値は 1000 エントリになります。
注
返されるエントリの最大数と制限時間が、サーバーで設定されている制限を超えた場合、サーバー設定によってコンポーネントの設定がオーバーライドされます。
DirectorySearcher クラスのインスタンスの初期プロパティ値の一覧については、DirectorySearcher() コンストラクターを参照してください。
注
このクラスを使用する前に、Active Directory Domain Services に関する一般的な理解があることを前提としています。 詳細については、System.DirectoryServices の概要を参照してください。
コンストラクター
| 名前 | 説明 |
|---|---|
| DirectorySearcher() |
既定値を使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry, String, String[], SearchScope) |
指定した検索ルート、検索フィルター、取得するプロパティ、および検索スコープを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry, String, String[]) |
指定した検索ルート、検索フィルター、および取得するプロパティを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry, String) |
指定した検索ルートと検索フィルターを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry) |
指定した検索ルートを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(String, String[], SearchScope) |
指定した検索フィルター、取得するプロパティ、および検索スコープを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(String, String[]) |
指定した検索フィルターと取得するプロパティを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(String) |
指定した検索フィルターを使用して、 DirectorySearcher クラスの新しいインスタンスを初期化します。 |
プロパティ
| 名前 | 説明 |
|---|---|
| Asynchronous |
検索が非同期に実行されるかどうかを示す値を取得または設定します。 |
| AttributeScopeQuery |
検索対象の識別名属性の LDAP 表示名を取得または設定します。 この種類の検索に使用できる属性は 1 つだけです。 |
| CacheResults |
結果がクライアント コンピューターにキャッシュされるかどうかを示す値を取得または設定します。 |
| CanRaiseEvents |
コンポーネントがイベントを発生できるかどうかを示す値を取得します。 (継承元 Component) |
| ClientTimeout |
クライアントがサーバーが結果を返すのを待機する最大時間を取得または設定します。 サーバーがこの時間内に応答しない場合、検索は中止され、結果は返されません。 |
| Container |
IContainerを含むComponentを取得します。 (継承元 Component) |
| DerefAlias |
検索中に見つかったオブジェクトのエイリアスを解決する方法を示す値を取得または設定します。 |
| DesignMode |
Componentが現在デザイン モードであるかどうかを示す値を取得します。 (継承元 Component) |
| DirectorySynchronization |
検索で使用するディレクトリ同期コントロールを表すオブジェクトを取得または設定します。 |
| Events |
この Componentにアタッチされているイベント ハンドラーの一覧を取得します。 (継承元 Component) |
| ExtendedDN |
識別名の形式を示す値を取得または設定します。 |
| Filter |
ライトウェイト ディレクトリ アクセス プロトコル (LDAP) 形式のフィルター文字列を示す値を取得または設定します。 |
| PageSize |
ページ検索のページ サイズを示す値を取得または設定します。 |
| PropertiesToLoad |
検索中に取得するプロパティの一覧を示す値を取得します。 |
| PropertyNamesOnly |
値が割り当てられている属性の名前のみを検索で取得するかどうかを示す値を取得または設定します。 |
| ReferralChasing |
紹介の追跡方法を示す値を取得または設定します。 |
| SearchRoot |
検索が開始される Active Directory Domain Services 階層内のノードを示す値を取得または設定します。 |
| SearchScope |
サーバーによって監視される検索の範囲を示す値を取得または設定します。 |
| SecurityMasks |
検索によって返される、指定した属性のセキュリティ アクセス情報を示す値を取得または設定します。 |
| ServerPageTimeLimit |
サーバーが個々の結果ページを検索する最大時間を示す値を取得または設定します。 これは、検索全体の時間制限と同じではありません。 |
| ServerTimeLimit |
ServerTimeLimit プロパティは、サーバーが検索に費やす最大時間を示す値を取得または設定します。 制限時間に達すると、その時点まで見つかったエントリのみが返されます。 |
| Site | (継承元 Component) |
| SizeLimit |
サーバーが検索で返すオブジェクトの最大数を示す値を取得または設定します。 |
| Sort |
結果を並べ替えるプロパティを示す値を取得または設定します。 |
| Tombstone |
検索フィルターに一致する削除されたオブジェクトも検索で返す必要があるかどうかを示す値を取得または設定します。 |
| VirtualListView |
検索の仮想リスト ビュー オプションを示す値を取得または設定します。 |
メソッド
| 名前 | 説明 |
|---|---|
| CreateObjRef(Type) |
リモート オブジェクトとの通信に使用されるプロキシの生成に必要なすべての関連情報を含むオブジェクトを作成します。 (継承元 MarshalByRefObject) |
| Dispose() |
Componentによって使用されるすべてのリソースを解放します。 (継承元 Component) |
| Dispose(Boolean) |
DirectorySearcher オブジェクトによって使用されるマネージド リソースを解放し、必要に応じてアンマネージド リソースを解放します。 |
| Equals(Object) |
指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
| FindAll() |
検索を実行し、見つかったエントリのコレクションを返します。 |
| FindOne() |
検索を実行し、最初に見つかったエントリのみを返します。 |
| GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
| GetLifetimeService() |
古い.
このインスタンスの有効期間ポリシーを制御する現在の有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject) |
| GetService(Type) |
ComponentまたはそのContainerによって提供されるサービスを表すオブジェクトを返します。 (継承元 Component) |
| GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
| InitializeLifetimeService() |
古い.
このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject) |
| MemberwiseClone() |
現在の Objectの簡易コピーを作成します。 (継承元 Object) |
| MemberwiseClone(Boolean) |
現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (継承元 MarshalByRefObject) |
| ToString() |
Stringの名前 (存在する場合) を含むComponentを返します。 このメソッドはオーバーライドしないでください。 (継承元 Component) |
イベント
| 名前 | 説明 |
|---|---|
| Disposed |
コンポーネントが Dispose() メソッドの呼び出しによって破棄されるときに発生します。 (継承元 Component) |
