DirectorySearcher Класс

Ссылка

Определение

Пространство имен:: System.DirectoryServices

Сборка:: System.DirectoryServices.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

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

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

Наследование: Object

MarshalByRefObject

Component
DirectorySearcher

Атрибуты: DSDescriptionAttribute

DirectorySearcher Используйте объект для поиска и выполнения запросов к иерархии доменные службы Active Directory с помощью протокола LDAP. LDAP — это единственный системный поставщик интерфейсов службы Active Directory (ADSI), который поддерживает поиск в каталоге. Администратор может создавать, изменять и удалять объекты, найденные в иерархии. Дополнительные сведения см. в разделе "Использование System.DirectoryServices".

При создании экземпляра DirectorySearcherукажите корень, который требуется получить, и необязательный список свойств для извлечения. Это SearchRoot свойство позволяет задать дополнительные свойства для выполнения следующих задач:

Кэшируйте результаты поиска на локальном компьютере. CacheResults Задайте свойство для true хранения сведений о каталоге на локальном компьютере. Актуальные данные выполняются в этот локальный кэш и фиксируются в доменные службы Active Directory только при вызове DirectoryEntry.CommitChanges метода.
Укажите продолжительность поиска с помощью ServerTimeLimit свойства.
Получение только имен атрибутов. PropertyNamesOnly Задайте для свойства true получение только имен атрибутов, которым назначены значения.
Выполните поиск по страницам. PageSize Задайте свойство, чтобы указать максимальное количество объектов, возвращаемых при поиске по страницам. Если вы не хотите выполнять поиск по страницам, присвойте PageSize свойству значение по умолчанию равно нулю.
Укажите максимальное количество возвращаемых записей с помощью SizeLimit свойства. Если для свойства задано SizeLimit значение по умолчанию равно нулю, то значение по умолчанию для сервера равно 1000 записей.

Примечание

Если максимальное количество возвращаемых записей и ограничений времени превышает ограничения, заданные на сервере, параметры сервера переопределяют параметры компонента.

Список начальных значений свойств для экземпляра класса DirectorySearcher см. в описании конструктора DirectorySearcher().

Примечание

Предполагается, что перед использованием этого класса у вас есть общее представление о доменные службы Active Directory. Дополнительные сведения см. в обзоре 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 (Lightweight Directory Access Protocol).
PageSize	Получает или задает значение, указывающее размер страницы при поиске с постраничным выводом.
PropertiesToLoad	Получает значение, указывающее список свойств для извлечения в ходе поиска.
PropertyNamesOnly	Получает или задает значение, указывающее, следует ли при поиске извлекать только имена атрибутов, которым присвоены значения.
ReferralChasing	Получает или задает значение, указывающее режим прослеживания отсылок.
SearchRoot	Получает или задает значение, указывающее узел в иерархии доменных служб Active Directory, с которого начинается поиск.
SearchScope	Получает или задает значение, указывающее область поиска, соблюдаемую сервером.
SecurityMasks	Получает или задает значение, указывающее, какая информация доступа безопасности для указанных атрибутов должна возвращаться при поиске.
ServerPageTimeLimit	Получает или задает значение, указывающее максимальный объем времени, в течение которого сервер будет производить поиск индивидуальной страницы результатов. Данное значение не идентично значению ограничения времени для поиска в целом.
ServerTimeLimit	Свойство ServerTimeLimit получает или задает значение, указывающее максимальный объем времени, затрачиваемого сервером при поиске. Если этот предел времени достигнут, возвращаются только элементы, найденные к этому моменту.
Site	Получает или задает ISite объекта Component. (Унаследовано от 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)

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