DirectorySearcher クラス

定義

Active Directory ドメイン サービスに対してクエリを実行します。Performs queries against Active Directory Domain Services.

public ref class DirectorySearcher : System::ComponentModel::Component
public class DirectorySearcher : System.ComponentModel.Component
[System.DirectoryServices.DSDescription("DirectorySearcherDesc")]
public class DirectorySearcher : System.ComponentModel.Component
type DirectorySearcher = class
    inherit Component
[<System.DirectoryServices.DSDescription("DirectorySearcherDesc")>]
type DirectorySearcher = class
    inherit Component
Public Class DirectorySearcher
Inherits Component
継承
DirectorySearcher
属性

注釈

オブジェクトを使用し DirectorySearcher て、ライトウェイトディレクトリアクセスプロトコル (LDAP) を使用して Active Directory Domain Services 階層に対してクエリを検索して実行します。Use a DirectorySearcher object to search and perform queries against an Active Directory Domain Services hierarchy using Lightweight Directory Access Protocol (LDAP). LDAP は、ディレクトリ検索をサポートする、システム提供の唯一の Active Directory サービスインターフェイス (ADSI) プロバイダーです。LDAP is the only system-supplied Active Directory Service Interfaces (ADSI) provider that supports directory searching. 管理者は、階層内で検出されたオブジェクトの作成、変更、および削除を行うことができます。An administrator can make, alter, and delete objects that are found in the hierarchy. 詳細については、「 Using system.directoryservices」を参照してください。For more information, see Using System.DirectoryServices.

のインスタンスを作成するときに DirectorySearcher 、取得するルートと、取得するプロパティのオプションのリストを指定します。When you create an instance of DirectorySearcher, you specify the root you want to retrieve, and an optional list of properties to retrieve. SearchRootプロパティを使用すると、次のタスクを実行するための追加のプロパティを設定できます。The SearchRoot property enables you to set additional properties to do the following tasks:

  • 検索結果をローカルコンピューターにキャッシュします。Cache the search results on the local computer. CacheResults true ローカルコンピューター上のディレクトリ情報を格納するには、プロパティをに設定します。Set the CacheResults property to true to store directory information on the local computer. このローカルキャッシュに更新が行われ、メソッドが呼び出された場合にのみ Active Directory Domain Services にコミットされ DirectoryEntry.CommitChanges ます。Updates are made to this local cache and committed to Active Directory Domain Services only when the DirectoryEntry.CommitChanges method is called.

  • プロパティを使用して、検索する時間の長さを指定し ServerTimeLimit ます。Specify the length of time to search, using the ServerTimeLimit property.

  • 属性名のみを取得します。Retrieve attribute names only. PropertyNamesOnly true 値が割り当てられている属性の名前だけを取得するには、プロパティをに設定します。Set the PropertyNamesOnly property to true to retrieve only the names of attributes to which values have been assigned.

  • ページング検索を実行します。Perform a paged search. PageSizeページングされた検索で返されるオブジェクトの最大数を指定するには、プロパティを設定します。Set the PageSize property to specify the maximum number of objects that are returned in a paged search. ページングされた検索を実行しない場合は、 PageSize プロパティを既定値の0に設定します。If you do not want to perform a paged search, set the PageSize property to its default of zero.

  • プロパティを使用して、返すエントリの最大数を指定し SizeLimit ます。Specify the maximum number of entries to return, using the SizeLimit property. この SizeLimit プロパティを既定値の0に設定した場合、サーバーによって既定で定義されている既定値は1000エントリです。If you set the SizeLimit property to its default of zero, the server-determined default is 1000 entries.

注意

返されるエントリの最大数と制限時間が、サーバーで設定されている制限を超えると、サーバーの設定によってコンポーネントの設定が上書きされます。If the maximum number of returned entries and time limits exceed the limitations that are set on the server, the server settings override the component settings.

DirectorySearcher クラスのインスタンスの初期プロパティ値一覧については、DirectorySearcher() コンストラクターに関するトピックを参照してください。For a list of initial property values for an instance of the DirectorySearcher class, see the DirectorySearcher() constructor.

注意

このクラスを使用する前に、Active Directory Domain Services についての全般的な知識があることを前提としています。It is assumed that you have a general understanding of Active Directory Domain Services before using this class. 詳細については、「概要」を参照してください System.DirectoryServicesFor more information, see the System.DirectoryServices overview.

コンストラクター

DirectorySearcher()

DirectorySearcher クラスの新しいインスタンスを既定値で初期化します。Initializes a new instance of the DirectorySearcher class with default values.

DirectorySearcher(DirectoryEntry)

指定した検索ルートを使用して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class using the specified search root.

DirectorySearcher(DirectoryEntry, String)

検索ルートと検索フィルターを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class with the specified search root and search filter.

DirectorySearcher(DirectoryEntry, String, String[])

検索ルート、検索フィルター、および取得するプロパティを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class with the specified search root, search filter, and properties to retrieve.

DirectorySearcher(DirectoryEntry, String, String[], SearchScope)

検索ルート、検索フィルター、取得するプロパティ、および検索のスコープを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class with the specified search root, search filter, properties to retrieve, and search scope.

DirectorySearcher(String)

検索フィルターを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class with the specified search filter.

DirectorySearcher(String, String[])

検索フィルターと取得するプロパティを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class with the specified search filter and properties to retrieve.

DirectorySearcher(String, String[], SearchScope)

検索フィルター、取得するプロパティ、および検索のスコープを指定して、DirectorySearcher クラスの新しいインスタンスを初期化します。Initializes a new instance of the DirectorySearcher class with the specified search filter, properties to retrieve, and search scope.

プロパティ

Asynchronous

検索が非同期に実行されるかどうかを示す値を取得または設定します。Gets or sets a value that indicates if the search is performed asynchronously.

AttributeScopeQuery

検索対象とする識別名の属性の LDAP 表示名を取得または設定します。Gets or sets the LDAP display name of the distinguished name attribute to search in. この種類の検索では 1 つの属性だけを使用できます。Only one attribute can be used for this type of search.

CacheResults

クライアント コンピューターに結果をキャッシュするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the result is cached on the client computer.

CanRaiseEvents

コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。Gets a value indicating whether the component can raise an event.

(継承元 Component)
ClientTimeout

サーバーが結果を返すまでクライアントが待機する最大時間を取得または設定します。Gets or sets the maximum amount of time that the client waits for the server to return results. サーバーがこの時間内に応答しない場合、検索は中止され、結果は返されません。If the server does not respond within this time, the search is aborted and no results are returned.

Container

IContainer を含む Component を取得します。Gets the IContainer that contains the Component.

(継承元 Component)
DerefAlias

検索中に見つかったオブジェクトのエイリアスを解決する方法を示す値を取得または設定します。Gets or sets a value indicating how the aliases of objects that are found during a search should be resolved.

DesignMode

Component が現在デザイン モードかどうかを示す値を取得します。Gets a value that indicates whether the Component is currently in design mode.

(継承元 Component)
DirectorySynchronization

検索時に使用するディレクトリ同期の制御を表すオブジェクトを取得または設定します。Gets or sets an object that represents the directory synchronization control to use with the search.

Events

Component に結び付けられているイベント ハンドラーのリストを取得します。Gets the list of event handlers that are attached to this Component.

(継承元 Component)
ExtendedDN

識別名の形式を示す値を取得または設定します。Gets or sets a value that indicates the format of the distinguished names.

Filter

LDAP 書式のフィルター文字列を示す値を取得または設定します。Gets or sets a value indicating the Lightweight Directory Access Protocol (LDAP) format filter string.

PageSize

ページ検索のページのサイズを示す値を取得または設定します。Gets or sets a value indicating the page size in a paged search.

PropertiesToLoad

検索中に取得するプロパティの一覧を示す値を取得または設定します。Gets a value indicating the list of properties to retrieve during the search.

PropertyNamesOnly

検索で値が割り当てられている属性の名前だけを取得するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the search retrieves only the names of attributes to which values have been assigned.

ReferralChasing

参照追跡を行う方法を示す値を取得または設定します。Gets or sets a value indicating how referrals are chased.

SearchRoot

検索を開始する Active Directory ドメイン サービス階層のノードを示す値を取得または設定します。Gets or sets a value indicating the node in the Active Directory Domain Services hierarchy where the search starts.

SearchScope

サーバーが監視する検索のスコープを示す値を取得または設定します。Gets or sets a value indicating the scope of the search that is observed by the server.

SecurityMasks

検索によって返される必要がある、指定した属性に対するセキュリティ アクセス情報を示す値を取得または設定します。Gets or sets a value indicating which security access information for the specified attributes should be returned by the search.

ServerPageTimeLimit

サーバーが結果の各ページを検索するための最大時間を示す値を取得または設定します。Gets or sets a value indicating the maximum amount of time the server should search for an individual page of results. これは、全体を検索するときの制限時間とは異なります。This is not the same as the time limit for the entire search.

ServerTimeLimit

ServerTimeLimit プロパティは、サーバーが検索に使用する最大時間を示す値を取得または設定します。The ServerTimeLimit property gets or sets a value indicating the maximum amount of time the server spends searching. 時間制限に達した場合は、その時点までに検索されたエントリだけが返されます。If the time limit is reached, only entries that are found up to that point are returned.

Site

ComponentISite を取得または設定します。Gets or sets the ISite of the Component.

(継承元 Component)
SizeLimit

サーバーが検索で返すオブジェクトの最大数を示す値を取得または設定します。Gets or sets a value indicating the maximum number of objects that the server returns in a search.

Sort

結果を並べ替えるプロパティを示す値を取得または設定します。Gets or sets a value indicating the property on which the results are sorted.

Tombstone

検索フィルターに一致する削除されたオブジェクトも、検索で返す必要があるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the search should also return deleted objects that match the search filter.

VirtualListView

仮想一覧表示の検索時のオプションを示す値を取得または設定します。Gets or sets a value indicating the virtual list view options for the search.

メソッド

CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(継承元 MarshalByRefObject)
Dispose()

Component によって使用されているすべてのリソースを解放します。Releases all resources used by the Component.

(継承元 Component)
Dispose(Boolean)

DirectorySearcher オブジェクトによって使用されているマネージド リソースを解放します。オプションでアンマネージド リソースも解放できます。Releases the managed resources that are used by the DirectorySearcher object and, optionally, releases unmanaged resources.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
FindAll()

検索を実行し、見つかったエントリのコレクションを返します。Executes the search and returns a collection of the entries that are found.

FindOne()

検索を実行し、最初に見つかったエントリだけを返します。Executes the search and returns only the first entry that is found.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetLifetimeService()
互換性のために残されています。

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(継承元 MarshalByRefObject)
GetService(Type)

Component またはその Container で提供されるサービスを表すオブジェクトを返します。Returns an object that represents a service provided by the Component or by its Container.

(継承元 Component)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
InitializeLifetimeService()
互換性のために残されています。

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。Obtains a lifetime service object to control the lifetime policy for this instance.

(継承元 MarshalByRefObject)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。Creates a shallow copy of the current MarshalByRefObject object.

(継承元 MarshalByRefObject)
ToString()

Component の名前 (存在する場合) を格納する String を返します。Returns a String containing the name of the Component, if any. このメソッドはオーバーライドできません。This method should not be overridden.

(継承元 Component)

イベント

Disposed

Dispose() メソッドの呼び出しによってコンポーネントが破棄されるときに発生します。Occurs when the component is disposed by a call to the Dispose() method.

(継承元 Component)

適用対象

こちらもご覧ください