DirectorySearcher DirectorySearcher DirectorySearcher DirectorySearcher Class

Определение

Выполняет запросы по доменным службам Active Directory.Performs queries against Active Directory Domain Services.

public ref class DirectorySearcher : System::ComponentModel::Component
[System.DirectoryServices.DSDescription("DirectorySearcherDesc")]
public class DirectorySearcher : System.ComponentModel.Component
type DirectorySearcher = class
    inherit Component
Public Class DirectorySearcher
Inherits Component
Наследование
Атрибуты

Комментарии

DirectorySearcher Используйте объект для поиска и выполнения запросов к иерархии служб домен Active Directory Services с помощью протокола LDAP.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. Дополнительные сведения см. в разделе Использование 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 службах только при 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, прежде чем использовать этот класс.It is assumed that you have a general understanding of Active Directory Domain Services before using this class. Дополнительные сведения см. в System.DirectoryServices обзоре.For more information, see the System.DirectoryServices overview.

Конструкторы

DirectorySearcher() DirectorySearcher() DirectorySearcher() DirectorySearcher()

Инициализирует новый экземпляр класса DirectorySearcher со значениями по умолчанию.Initializes a new instance of the DirectorySearcher class with default values.

DirectorySearcher(DirectoryEntry) DirectorySearcher(DirectoryEntry) DirectorySearcher(DirectoryEntry) DirectorySearcher(DirectoryEntry)

Инициализирует новый экземпляр класса DirectorySearcher с помощью указанного корня поиска.Initializes a new instance of the DirectorySearcher class using the specified search root.

DirectorySearcher(DirectoryEntry, String) DirectorySearcher(DirectoryEntry, String) DirectorySearcher(DirectoryEntry, String) 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(DirectoryEntry, String, String[]) DirectorySearcher(DirectoryEntry, String, String[]) 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(DirectoryEntry, String, String[], SearchScope) DirectorySearcher(DirectoryEntry, String, String[], SearchScope) 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(String) DirectorySearcher(String) DirectorySearcher(String)

Инициализирует новый экземпляр класса DirectorySearcher с указанным фильтром поиска.Initializes a new instance of the DirectorySearcher class with the specified search filter.

DirectorySearcher(String, String[]) DirectorySearcher(String, String[]) DirectorySearcher(String, String[]) 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(String, String[], SearchScope) DirectorySearcher(String, String[], SearchScope) 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 Asynchronous Asynchronous Asynchronous

Получает или задает значение, указывающее, выполняется ли поиск асинхронно.Gets or sets a value that indicates if the search is performed asynchronously.

AttributeScopeQuery AttributeScopeQuery AttributeScopeQuery AttributeScopeQuery

Получает или задает отображаемое имя LDAP атрибута отличительного имени для поиска.Gets or sets the LDAP display name of the distinguished name attribute to search in. Только один атрибут может использоваться для поиска данного типа.Only one attribute can be used for this type of search.

CacheResults CacheResults CacheResults CacheResults

Получает или задает значение, указывающее, следует ли записывать результат в кэш на клиентском компьютере.Gets or sets a value indicating whether the result is cached on the client computer.

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Возвращает значение, показывающее, может ли компонент вызывать событие.Gets a value indicating whether the component can raise an event.

(Inherited from Component)
ClientTimeout ClientTimeout ClientTimeout 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 Container Container Container

Возвращает контейнер IContainer, содержащий компонент Component.Gets the IContainer that contains the Component.

(Inherited from Component)
DerefAlias DerefAlias DerefAlias DerefAlias

Получает или задает значение, указывающее режим распознавания псевдонимов объектов, обнаруженных в ходе поиска.Gets or sets a value indicating how the aliases of objects that are found during a search should be resolved.

DesignMode DesignMode DesignMode DesignMode

Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время.Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
DirectorySynchronization DirectorySynchronization DirectorySynchronization DirectorySynchronization

Получает или задает объект, представляющий элемент управления синхронизации каталога для использования при поиске.Gets or sets an object that represents the directory synchronization control to use with the search.

Events Events Events Events

Возвращает список обработчиков событий, которые прикреплены к этому объекту Component.Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
ExtendedDN ExtendedDN ExtendedDN ExtendedDN

Получает или задает значение, указывающее формат отличительных имен.Gets or sets a value that indicates the format of the distinguished names.

Filter Filter Filter Filter

Получает или задает значение, указывающее строку фильтра формата LDAP (Lightweight Directory Access Protocol).Gets or sets a value indicating the Lightweight Directory Access Protocol (LDAP) format filter string.

PageSize PageSize PageSize PageSize

Получает или задает значение, указывающее размер страницы при поиске с постраничным выводом.Gets or sets a value indicating the page size in a paged search.

PropertiesToLoad PropertiesToLoad PropertiesToLoad PropertiesToLoad

Получает значение, указывающее список свойств для извлечения в ходе поиска.Gets a value indicating the list of properties to retrieve during the search.

PropertyNamesOnly PropertyNamesOnly PropertyNamesOnly PropertyNamesOnly

Получает или задает значение, указывающее, следует ли при поиске извлекать только имена атрибутов, которым присвоены значения.Gets or sets a value indicating whether the search retrieves only the names of attributes to which values have been assigned.

ReferralChasing ReferralChasing ReferralChasing ReferralChasing

Получает или задает значение, указывающее режим прослеживания отсылок.Gets or sets a value indicating how referrals are chased.

SearchRoot SearchRoot SearchRoot SearchRoot

Получает или задает значение, указывающее узел в иерархии доменных служб Active Directory, с которого начинается поиск.Gets or sets a value indicating the node in the Active Directory Domain Services hierarchy where the search starts.

SearchScope SearchScope SearchScope SearchScope

Получает или задает значение, указывающее область поиска, соблюдаемую сервером.Gets or sets a value indicating the scope of the search that is observed by the server.

SecurityMasks SecurityMasks SecurityMasks SecurityMasks

Получает или задает значение, указывающее, какая информация доступа безопасности для указанных атрибутов должна возвращаться при поиске.Gets or sets a value indicating which security access information for the specified attributes should be returned by the search.

ServerPageTimeLimit ServerPageTimeLimit ServerPageTimeLimit 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 ServerTimeLimit 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 Site Site Site

Возвращает или задает ISite объекта Component.Gets or sets the ISite of the Component.

(Inherited from Component)
SizeLimit SizeLimit SizeLimit SizeLimit

Получает или задает значение, указывающее максимальное количество объектов, возвращаемых сервером при поиске.Gets or sets a value indicating the maximum number of objects that the server returns in a search.

Sort Sort Sort Sort

Получает или задает значение, указывающее свойство, по которому будут сортироваться результаты.Gets or sets a value indicating the property on which the results are sorted.

Tombstone Tombstone Tombstone Tombstone

Получает или задает значение, указывающее, следует ли в ходе поиска также возвращать удаленные объекты, соответствующие фильтру поиска.Gets or sets a value indicating whether the search should also return deleted objects that match the search filter.

VirtualListView VirtualListView VirtualListView VirtualListView

Получает или задает значение, указывающее параметры виртуального представления списка для поиска.Gets or sets a value indicating the virtual list view options for the search.

Методы

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()

Освобождает все ресурсы, занятые модулем Component.Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Освобождает управляемые (а при необходимости и неуправляемые) ресурсы, используемые объектом DirectorySearcher.Releases the managed resources that are used by the DirectorySearcher object and, optionally, releases unmanaged resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindAll() FindAll() FindAll() FindAll()

Выполняет поиск и возвращает коллекцию найденных элементов.Executes the search and returns a collection of the entries that are found.

FindOne() FindOne() FindOne() FindOne()

Выполняет поиск и возвращает только первый найденный элемент.Executes the search and returns only the first entry that is found.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Возвращает объект, представляющий службу, обеспечиваемую компонентом Component или его контейнером Container.Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
ToString() ToString() ToString() ToString()

Возвращает объект String, содержащий имя Component, если оно есть.Returns a String containing the name of the Component, if any. Этот метод не следует переопределять.This method should not be overridden.

(Inherited from Component)

События

Disposed Disposed Disposed Disposed

Происходит при удалении компонента вызовом метода Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)

Безопасность

DirectoryServicesPermission
LinkDemand

Применяется к

Дополнительно