DirectorySearcher 類別

定義

命名空間:

System.DirectoryServices

組件:

System.DirectoryServices.dll

套件:

System.DirectoryServices v9.0.0-rc.1.24431.7

來源:

DirectorySearcher.cs

對 Active Directory 執行查詢。

public ref class DirectorySearcher : System::ComponentModel::Component

public class DirectorySearcher : System.ComponentModel.Component

type DirectorySearcher = class
    inherit Component

Public Class DirectorySearcher
Inherits Component

繼承

Object

MarshalByRefObject

Component

DirectorySearcher

備註

DirectorySearcher使用物件，使用輕量型目錄存取通訊協定 (LDAP) 來搜尋及執行 Active Directory Domain Services 階層的查詢。 LDAP 是唯一系統提供的 Active Directory 服務介面， (ADSI) 提供者，可支援目錄搜尋。 系統管理員可以建立、改變和刪除階層中找到的物件。 如需詳細資訊，請參閱 使用 System.DirectoryServices。

當您建立 的 DirectorySearcher實例時，您會指定要擷取的根目錄，以及要擷取的屬性選擇性清單。 屬性 SearchRoot 可讓您設定其他屬性來執行下列工作：

• 快取本機電腦上的搜尋結果。 將屬性設定為 true ，CacheResults以將目錄資訊儲存在本機計算機上。 只有在呼叫 方法時 DirectoryEntry.CommitChanges ，才會對此本機快取進行更新，並認可至 Active Directory Domain Services。

• 使用 ServerTimeLimit 屬性指定搜尋的時間長度。

• 僅擷取屬性名稱。 將 PropertyNamesOnly 屬性設定為 true ，只擷取已指派值的屬性名稱。

• 執行分頁搜尋。 PageSize設定 屬性，以指定在分頁搜尋中傳回的物件數目上限。 如果您不想執行分頁搜尋，請將 PageSize 屬性設定為預設值為零。

• 使用 SizeLimit 屬性，指定要傳回的項目數目上限。 如果您將 SizeLimit 屬性設定為預設值為零，則伺服器決定的預設值為1000個專案。

注意

如果傳回的項目數目上限和時間限制超過伺服器上設定的限制，伺服器設定會覆寫元件設定。

如需 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 顯示名稱， 只有一個屬性可用於這種類型的搜尋。
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)	建立包含所有相關資訊的物件，這些資訊是產生用來與遠端物件通訊的所需 Proxy。 (繼承來源 MarshalByRefObject)
Dispose()	釋放 Component 所使用的所有資源。 (繼承來源 Component)
Dispose(Boolean)	釋放 DirectorySearcher 物件所使用的 Managed 資源，並選擇性地釋放 Unmanaged 資源。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
FindAll()	執行搜尋並傳回找到的項目集合。
FindOne()	執行搜尋並且只傳回找到的第一個項目。
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetLifetimeService()	已淘汰. 擷取控制這個執行個體存留期 (Lifetime) 原則的目前存留期服務物件。 (繼承來源 MarshalByRefObject)
GetService(Type)	傳回表示 Component 或其 Container 所提供之服務的物件。 (繼承來源 Component)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
InitializeLifetimeService()	已淘汰. 取得存留期服務物件，以控制這個執行個體的存留期原則。 (繼承來源 MarshalByRefObject)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
MemberwiseClone(Boolean)	建立目前 MarshalByRefObject 物件的淺層複本。 (繼承來源 MarshalByRefObject)
ToString()	傳回任何包含 Component 名稱的 String。 不應覆寫此方法。 (繼承來源 Component)

事件

Disposed

當 Dispose() 方法的呼叫處置元件時，就會發生。 (繼承來源 Component)

另請參閱

• DirectoryEntries
• DirectoryEntry
• DirectorySearcher
• DirectorySearcher
• PropertyCollection
• PropertyValueCollection
• ReferralChasingOption
• SearchResultCollection
• SearchResult
• ResultPropertyValueCollection
• SearchScope
• SortDirection
• SortOption
• System.DirectoryServices