DirectorySearcher Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Realiza consultas contra o Active Directory Domain Services.
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
- Herança
- Atributos
Observações
Use um objeto DirectorySearcher para pesquisar e realizar consultas contra uma hierarquia Active Directory Domain Services usando o Protocolo Leve de Acesso a Diretórios (LDAP). O LDAP é o único fornecedor de Interfaces de Serviço Active Directory (ADSI) fornecido pelo sistema que suporta pesquisa de diretórios. Um administrador pode criar, alterar e eliminar objetos que se encontram na hierarquia. Para mais informações, consulte Using System.DirectoryServices.
Quando crias uma instância de DirectorySearcher, especificas a raiz que queres recuperar e uma lista opcional de propriedades a recuperar. A SearchRoot propriedade permite-lhe definir propriedades adicionais para realizar as seguintes tarefas:
Guarde os resultados da pesquisa no computador local. Defina a CacheResults propriedade para
truearmazenar a informação do diretório no computador local. As atualizações são feitas a esta cache local e confirmadas para Active Directory Domain Services apenas quando o método DirectoryEntry.CommitChanges é chamado.Especifique o tempo de pesquisa usando a ServerTimeLimit propriedade.
Recuperar apenas nomes de atributos. Defina a PropertyNamesOnly propriedade para
truerecuperar apenas os nomes dos atributos a que os valores foram atribuídos.Faça uma pesquisa paginada. Defina a PageSize propriedade para especificar o número máximo de objetos que são devolvidos numa pesquisa paginada. Se não quiser realizar uma pesquisa paginada, defina a PageSize propriedade para zero.
Especifique o número máximo de entradas a devolver, usando a SizeLimit propriedade. Se definires a SizeLimit propriedade para zero, o padrão determinado pelo servidor é 1000 entradas.
Note
Se o número máximo de entradas devolvidas e os limites de tempo excederem as limitações definidas no servidor, as definições do servidor sobrepõem-se às definições dos componentes.
Para uma lista de valores iniciais de propriedades para uma instância da DirectorySearcher classe, veja o DirectorySearcher() construtor.
Note
Presume-se que tens uma compreensão geral do Active Directory Domain Services antes de usar esta classe. Para mais informações, consulte a System.DirectoryServices visão geral.
Construtores
| Name | Description |
|---|---|
| DirectorySearcher() |
Inicializa uma nova instância da DirectorySearcher classe com valores por defeito. |
| DirectorySearcher(DirectoryEntry, String, String[], SearchScope) |
Inicializa uma nova instância da DirectorySearcher classe com a raiz de pesquisa especificada, filtro de pesquisa, propriedades a recuperar e escopo de pesquisa. |
| DirectorySearcher(DirectoryEntry, String, String[]) |
Inicializa uma nova instância da DirectorySearcher classe com a raiz de pesquisa especificada, filtro de pesquisa e propriedades a recuperar. |
| DirectorySearcher(DirectoryEntry, String) |
Inicializa uma nova instância da DirectorySearcher classe com a raiz de pesquisa e o filtro de pesquisa especificados. |
| DirectorySearcher(DirectoryEntry) |
Inicializa uma nova instância da DirectorySearcher classe usando a raiz de pesquisa especificada. |
| DirectorySearcher(String, String[], SearchScope) |
Inicializa uma nova instância da DirectorySearcher classe com o filtro de pesquisa especificado, propriedades a recuperar e o âmbito de pesquisa. |
| DirectorySearcher(String, String[]) |
Inicializa uma nova instância da DirectorySearcher classe com o filtro de pesquisa e propriedades especificados para recuperar. |
| DirectorySearcher(String) |
Inicializa uma nova instância da DirectorySearcher classe com o filtro de pesquisa especificado. |
Propriedades
| Name | Description |
|---|---|
| Asynchronous |
Recebe ou define um valor que indica se a pesquisa é realizada de forma assíncrona. |
| AttributeScopeQuery |
Obtém ou define o nome de exibição LDAP do atributo do nome distinto para pesquisar. Apenas um atributo pode ser usado para este tipo de pesquisa. |
| CacheResults |
Recebe 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 gerar um evento. (Herdado de Component) |
| ClientTimeout |
Obtém ou define o tempo máximo que o cliente espera que o servidor devolva os resultados. Se o servidor não responder dentro desse período, a pesquisa é abortada e não são retornados resultados. |
| Container |
Obtém o IContainer que contém o Component. (Herdado de Component) |
| DerefAlias |
Obtém ou define um valor que indica como os pseudónimos dos objetos encontrados durante uma pesquisa devem ser resolvidos. |
| DesignMode |
Obtém um valor que indica se o Component está atualmente em modo de design. (Herdado de Component) |
| DirectorySynchronization |
Obtém ou define um objeto que representa o controlo de sincronização de diretórios para usar na pesquisa. |
| Events |
Obtém a lista de gestores de eventos que estão ligados a isto Component. (Herdado de Component) |
| ExtendedDN |
Obtém ou define um valor que indica o formato dos nomes distinguidos. |
| Filter |
Recebe ou define um valor que indica a cadeia de filtro do formato Lightweight Directory Access Protocol (LDAP). |
| PageSize |
Obtém ou define um valor que indica o tamanho da página numa pesquisa paginada. |
| PropertiesToLoad |
Recebe um valor que indica a lista de propriedades a recuperar durante a pesquisa. |
| PropertyNamesOnly |
Obtém ou define um valor que indica se a pesquisa recupera apenas os nomes dos atributos a que os valores foram atribuídos. |
| ReferralChasing |
Recebe ou define um valor que indica como as referências são perseguidas. |
| SearchRoot |
Recebe ou define um valor que indica o nó na hierarquia do Active Directory Domain Services onde a pesquisa começa. |
| SearchScope |
Recebe ou define um valor que indica o âmbito da pesquisa que é observado pelo servidor. |
| SecurityMasks |
Obtém ou define um valor que indica qual a informação de acesso de segurança para os atributos especificados que deve ser devolvida pela pesquisa. |
| ServerPageTimeLimit |
Recebe ou define um valor que indica o tempo máximo que o servidor deve procurar por uma página individual de resultados. Isto não é o mesmo que o limite de tempo para toda a pesquisa. |
| ServerTimeLimit |
A ServerTimeLimit propriedade recebe ou define um valor que indica o tempo máximo que o servidor passa a pesquisar. Se o limite de tempo for atingido, apenas as entradas encontradas até esse ponto são devolvidas. |
| 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 devolve numa pesquisa. |
| Sort |
Obtém ou define um valor que indica a propriedade sobre a qual os resultados estão organizados. |
| Tombstone |
Recebe ou define um valor que indica se a pesquisa também deve devolver objetos eliminados que correspondam ao filtro de pesquisa. |
| VirtualListView |
Recebe ou define um valor que indica as opções de vista de lista virtual para a pesquisa. |
Métodos
| Name | Description |
|---|---|
| CreateObjRef(Type) |
Cria um objeto que contém toda a informação relevante necessária para gerar um proxy usado para comunicar com um objeto remoto. (Herdado de MarshalByRefObject) |
| Dispose() |
Liberta todos os recursos utilizados pelo Component. (Herdado de Component) |
| Dispose(Boolean) |
Liberta os recursos geridos que são usados pelo DirectorySearcher objeto e, opcionalmente, liberta recursos não geridos. |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| FindAll() |
Executa a pesquisa e devolve uma coleção das entradas encontradas. |
| FindOne() |
Executa a pesquisa e devolve apenas a primeira entrada encontrada. |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetLifetimeService() |
Recupera o objeto de serviço de tempo de vida atual que controla a política de vida útil neste caso. (Herdado de MarshalByRefObject) |
| GetService(Type) |
Devolve 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-se um objeto de serviço vitalício para controlar a apólice vitalícia neste caso. (Herdado de MarshalByRefObject) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| MemberwiseClone(Boolean) |
Cria uma cópia superficial do objeto atual MarshalByRefObject . (Herdado de MarshalByRefObject) |
| ToString() |
Devolve a String contendo o nome do Component, se existir. Este método não deve ser ultrapassado. (Herdado de Component) |
evento
| Name | Description |
|---|---|
| Disposed |
Ocorre quando o componente é eliminado por uma chamada ao Dispose() método. (Herdado de Component) |