DirectorySearcher クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Active Directory ドメイン サービスに対してクエリを実行します。
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- 継承
- 属性
注釈
オブジェクトをDirectorySearcher使用して、ライトウェイト ディレクトリ アクセス プロトコル (LDAP) を使用して、Active Directory Domain Services階層に対するクエリを検索および実行します。 LDAP は、ディレクトリ検索をサポートする唯一のシステム提供の Active Directory サービス インターフェイス (ADSI) プロバイダーです。 管理者は、階層内にあるオブジェクトを作成、変更、および削除できます。 詳細については、「 System.DirectoryServices の使用」を参照してください。
インスタンス DirectorySearcherを作成するときは、取得するルートと、取得するプロパティのオプションリストを指定します。 この SearchRoot プロパティを使用すると、次のタスクを実行する追加のプロパティを設定できます。
検索結果をローカル コンピューターにキャッシュします。 ローカル コンピューターに CacheResults ディレクトリ情報を
true格納するようにプロパティを設定します。 更新は、このローカル キャッシュに対して行われ、メソッドが呼び出されたときにのみDirectoryEntry.CommitChangesActive Directory Domain Servicesにコミットされます。プロパティを使用して、検索する時間の ServerTimeLimit 長さを指定します。
属性名のみを取得します。 値が PropertyNamesOnly 割り当てられている属性の名前のみを取得するようにプロパティ
trueを設定します。ページ検索を実行します。 PageSizeページ検索で返されるオブジェクトの最大数を指定するプロパティを設定します。 ページ検索を実行しない場合は、プロパティを PageSize 既定値の 0 に設定します。
プロパティを使用して、返すエントリの最大数を SizeLimit 指定します。 プロパティを SizeLimit 既定値の 0 に設定した場合、サーバーによって決定される既定値は 1,000 エントリです。
注意
返されるエントリの最大数と制限時間がサーバーで設定されている制限を超えている場合、サーバー設定はコンポーネントの設定をオーバーライドします。
DirectorySearcher クラスのインスタンスの初期プロパティ値一覧については、DirectorySearcher() コンストラクターに関するトピックを参照してください。
注意
このクラスを使用する前に、Active Directory Domain Servicesについて一般的に理解していることを前提としています。 詳細については、System.DirectoryServices の概要を参照してください。
コンストラクター
| DirectorySearcher() |
DirectorySearcher クラスの新しいインスタンスを既定値で初期化します。 |
| DirectorySearcher(DirectoryEntry) |
指定した検索ルートを使用して、DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry, String) |
検索ルートと検索フィルターを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry, String, String[]) |
検索ルート、検索フィルター、および取得するプロパティを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(DirectoryEntry, String, String[], SearchScope) |
検索ルート、検索フィルター、取得するプロパティ、および検索のスコープを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(String) |
検索フィルターを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(String, String[]) |
検索フィルターと取得するプロパティを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。 |
| DirectorySearcher(String, String[], SearchScope) |
検索フィルター、取得するプロパティ、および検索のスコープを指定して、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 ドメイン サービス階層のノードを示す値を取得または設定します。 |
| SearchScope |
サーバーが監視する検索のスコープを示す値を取得または設定します。 |
| SecurityMasks |
検索によって返される必要がある、指定した属性に対するセキュリティ アクセス情報を示す値を取得または設定します。 |
| ServerPageTimeLimit |
サーバーが結果の各ページを検索するための最大時間を示す値を取得または設定します。 これは、全体を検索するときの制限時間とは異なります。 |
| ServerTimeLimit |
ServerTimeLimit プロパティは、サーバーが検索に使用する最大時間を示す値を取得または設定します。 時間制限に達した場合は、その時点までに検索されたエントリだけが返されます。 |
| Site |
Component の ISite を取得または設定します。 (継承元 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() |
Component の名前 (存在する場合) を格納する String を返します。 このメソッドはオーバーライドできません。 (継承元 Component) |
events
| Disposed |
Dispose() メソッドの呼び出しによってコンポーネントが破棄されるときに発生します。 (継承元 Component) |