DirectorySearcher Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Выполняет запросы к доменным службам 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
- Наследование
- Атрибуты
Комментарии
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, String, String[], SearchScope) |
Инициализирует новый экземпляр DirectorySearcher класса с указанным корнем поиска, фильтром поиска, свойствами для извлечения и области поиска. |
| DirectorySearcher(DirectoryEntry, String, String[]) |
Инициализирует новый экземпляр DirectorySearcher класса с указанным корнем поиска, фильтром поиска и свойствами для извлечения. |
| DirectorySearcher(DirectoryEntry, String) |
Инициализирует новый экземпляр DirectorySearcher класса с указанным корнем поиска и фильтром поиска. |
| DirectorySearcher(DirectoryEntry) |
Инициализирует новый экземпляр класса с помощью указанного корневого DirectorySearcher каталога поиска. |
| DirectorySearcher(String, String[], SearchScope) |
Инициализирует новый экземпляр DirectorySearcher класса с указанным фильтром поиска, свойствами для извлечения и области поиска. |
| DirectorySearcher(String, String[]) |
Инициализирует новый экземпляр DirectorySearcher класса с указанным фильтром поиска и свойствами для извлечения. |
| DirectorySearcher(String) |
Инициализирует новый экземпляр 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 |
Возвращает или задает 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) |