DirectorySearcher Classe

Definição

Namespace:

System.DirectoryServices

Assembly:

System.DirectoryServices.dll

Pacote:

System.DirectoryServices v8.0.0

Origem:

DirectorySearcher.cs

Executa consultas com relação a Active Directory Domain Services.

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

public class DirectorySearcher : System.ComponentModel.Component

type DirectorySearcher = class
    inherit Component

Public Class DirectorySearcher
Inherits Component

Herança

Object

MarshalByRefObject

Component

DirectorySearcher

Comentários

Use um DirectorySearcher objeto para pesquisar e executar consultas em uma hierarquia de Active Directory Domain Services usando o LDAP (Lightweight Directory Access Protocol). O LDAP é o único provedor ADSI (Interfaces de Serviço active directory) fornecido pelo sistema que dá suporte à pesquisa de diretórios. Um administrador pode fazer, alterar e excluir objetos que são encontrados na hierarquia. Para obter mais informações, confira Usando System.DirectoryServices.

Ao criar uma instância do DirectorySearcher, especifique a raiz que deseja recuperar e uma lista opcional de propriedades a serem recuperadas. A SearchRoot propriedade permite que você defina propriedades adicionais para realizar as seguintes tarefas:

• Armazene em cache os resultados da pesquisa no computador local. Defina a CacheResults propriedade como true para armazenar informações de diretório no computador local. Atualizações são feitas nesse cache local e confirmadas com Active Directory Domain Services somente quando o DirectoryEntry.CommitChanges método é chamado.

• Especifique o período de tempo para pesquisar, usando a ServerTimeLimit propriedade .

• Recuperar apenas nomes de atributo. Defina a PropertyNamesOnly propriedade como true para recuperar apenas os nomes de atributos aos quais os valores foram atribuídos.

• Executar uma pesquisa paginada. Defina a PageSize propriedade para especificar o número máximo de objetos retornados em uma pesquisa paginada. Se você não quiser executar uma pesquisa paginada, defina a PageSize propriedade como o padrão de zero.

• Especifique o número máximo de entradas a serem retornadas, usando a SizeLimit propriedade . Se você definir a SizeLimit propriedade como o padrão de zero, o padrão determinado pelo servidor será 1000 entradas.

Observação

Se o número máximo de entradas e limites de tempo retornados exceder as limitações definidas no servidor, as configurações do servidor substituirão as configurações do componente.

Para obter uma lista de valores de propriedade iniciais para uma instância da DirectorySearcher classe , consulte o DirectorySearcher() construtor.

Observação

Supõe-se que você tenha uma compreensão geral de Active Directory Domain Services antes de usar essa classe. Para obter mais informações, confira a visão geral System.DirectoryServices.

Construtores

DirectorySearcher()	Inicializa uma nova instância da classe DirectorySearcher com valores padrão.
DirectorySearcher(DirectoryEntry)	Inicializa uma nova instância da classe DirectorySearcher usando a raiz de pesquisa especificada.
DirectorySearcher(DirectoryEntry, String)	Inicializa uma nova instância da classe DirectorySearcher com a raiz e o filtro de pesquisa especificados.
DirectorySearcher(DirectoryEntry, String, String[])	Inicializa uma nova instância da classe DirectorySearcher com a raiz de pesquisa e o filtro de pesquisa especificados e as propriedades a serem recuperadas.
DirectorySearcher(DirectoryEntry, String, String[], SearchScope)	Inicializa uma nova instância da classe DirectorySearcher com a raiz e o filtro de pesquisa especificados, as propriedades a serem recuperadas e o escopo da pesquisa.
DirectorySearcher(String)	Inicializa uma nova instância da classe DirectorySearcher com o filtro de pesquisa especificado.
DirectorySearcher(String, String[])	Inicializa uma nova instância da classe DirectorySearcher com o filtro de pesquisa especificado e as propriedades a serem recuperadas.
DirectorySearcher(String, String[], SearchScope)	Inicializa uma nova instância da classe DirectorySearcher com o filtro de pesquisa especificado, as propriedades a serem recuperadas e o escopo da pesquisa.

Propriedades

Asynchronous	Obtém ou define um valor que indica se a pesquisa é executada de forma assíncrona.
AttributeScopeQuery	Obtém ou define o nome de exibição LDAP do atributo de nome diferenciado a ser pesquisado. Somente um atributo pode ser usado para esse tipo de pesquisa.
CacheResults	Obtém ou define um valor que indica se o resultado está armazenado em cache no computador cliente.
CanRaiseEvents	Obtém um valor que indica se o componente pode acionar um evento. (Herdado de Component)
ClientTimeout	Obtém ou define o tempo máximo de espera do cliente para que o servidor retorne os resultados. Se o servidor não responder dentro desse período, a pesquisa será anulada e nenhum resultado será retornado.
Container	Obtém o IContainer que contém o Component. (Herdado de Component)
DerefAlias	Obtém ou define um valor que indica como os aliases de objetos que são encontrados durante uma pesquisa devem ser resolvidos.
DesignMode	Obtém um valor que indica se o Component está no modo de design no momento. (Herdado de Component)
DirectorySynchronization	Obtém ou define um objeto que representa o controle de sincronização de diretório a ser usado com a pesquisa.
Events	Obtém a lista de manipuladores de eventos que estão anexados a este Component. (Herdado de Component)
ExtendedDN	Obtém ou define um valor que indica o formato dos nomes distintos.
Filter	Obtém ou define um valor que indica a cadeia de caracteres de filtro de formato do protocolo LDAP.
PageSize	Obtém ou define um valor que indica o tamanho da página em uma pesquisa paginável.
PropertiesToLoad	Obtém um valor que indica a lista de propriedades a serem recuperadas durante a pesquisa.
PropertyNamesOnly	Obtém ou define um valor que indica se a pesquisa recupera somente os nomes dos atributos aos quais foram atribuídos valores.
ReferralChasing	Obtém ou define um valor que indica como as referências são buscadas.
SearchRoot	Obtém ou define um valor que indica o nó da hierarquia do Active Directory Domain Services onde a pesquisa se inicia.
SearchScope	Obtém ou define um valor que indica o escopo da pesquisa que é observado pelo servidor.
SecurityMasks	Obtém ou define um valor que indica quais informações de acesso de segurança para os atributos especificados devem ser retornadas pela pesquisa.
ServerPageTimeLimit	Obtém ou define um valor que indica a quantidade máxima de tempo que o servidor deve pesquisar uma página de resultados individual. Isso não é o mesmo que o limite de tempo para a pesquisa inteira.
ServerTimeLimit	A propriedade ServerTimeLimit obtém ou define um valor que indica o tempo máximo que o servidor gasta pesquisando. Se o tempo limite for atingido, apenas as entradas encontradas até esse ponto serão retornadas.
Site	Obtém ou define o ISite do Component. (Herdado de Component)
SizeLimit	Obtém ou define um valor que indica o número máximo de objetos que o servidor retorna em uma pesquisa.
Sort	Obtém ou define um valor que indica a propriedade na qual os resultados são classificados.
Tombstone	Obtém ou define um valor que indica se a pesquisa também deve retornar objetos excluídos que correspondem ao filtro de pesquisa.
VirtualListView	Obtém ou define um valor que indica as opções de exibição de lista virtual para a pesquisa.

Métodos

CreateObjRef(Type)	Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto. (Herdado de MarshalByRefObject)
Dispose()	Libera todos os recursos usados pelo Component. (Herdado de Component)
Dispose(Boolean)	Libera os recursos gerenciados usados pelo objeto DirectorySearcher e libera, opcionalmente, os recursos não gerenciados.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
FindAll()	Executa a pesquisa e retorna uma coleção das entradas encontradas.
FindOne()	Executa a pesquisa e retorna apenas a primeira entrada encontrada.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetLifetimeService()	Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância. (Herdado de MarshalByRefObject)
GetService(Type)	Retorna um objeto que representa um serviço fornecido pelo Component ou pelo seu Container. (Herdado de Component)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeLifetimeService()	Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
ToString()	Retorna um String que contém o nome do Component, se houver. Esse método não deve ser substituído. (Herdado de Component)

Eventos

Disposed

Ocorre quando o componente é disposto por uma chamada ao método Dispose(). (Herdado de Component)

Confira também

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