DirectorySearcher DirectorySearcher DirectorySearcher DirectorySearcher Class

Definición

Realiza consultas en los Servicios de dominio de 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
Herencia
Atributos

Comentarios

Use un DirectorySearcher objeto para buscar y realizar consultas en una jerarquía de Active Directory Domain Services mediante el Protocolo ligero de acceso a directorios (LDAP).Use a DirectorySearcher object to search and perform queries against an Active Directory Domain Services hierarchy using Lightweight Directory Access Protocol (LDAP). LDAP es el único proveedor de interfaces de servicio Active Directory (ADSI) proporcionado por el sistema que admite la búsqueda de directorios.LDAP is the only system-supplied Active Directory Service Interfaces (ADSI) provider that supports directory searching. Un administrador puede crear, modificar y eliminar objetos que se encuentran en la jerarquía.An administrator can make, alter, and delete objects that are found in the hierarchy. Para obtener más información, vea usar System. DirectoryServices.For more information, see Using System.DirectoryServices.

Cuando se crea una instancia de DirectorySearcher, se especifica la raíz que se desea recuperar y una lista opcional de las propiedades que se van a recuperar.When you create an instance of DirectorySearcher, you specify the root you want to retrieve, and an optional list of properties to retrieve. La SearchRoot propiedad permite establecer propiedades adicionales para realizar las siguientes tareas:The SearchRoot property enables you to set additional properties to do the following tasks:

  • Almacenar en caché los resultados de la búsqueda en el equipo local.Cache the search results on the local computer. Establezca la CacheResults propiedad en true para almacenar información de directorio en el equipo local.Set the CacheResults property to true to store directory information on the local computer. Las actualizaciones se realizan en esta caché local y se confirman en DirectoryEntry.CommitChanges Active Directory Domain Services solo cuando se llama al método.Updates are made to this local cache and committed to Active Directory Domain Services only when the DirectoryEntry.CommitChanges method is called.

  • Especifique el período de tiempo de búsqueda mediante la ServerTimeLimit propiedad.Specify the length of time to search, using the ServerTimeLimit property.

  • Solo se recuperan los nombres de atributo.Retrieve attribute names only. Establezca la PropertyNamesOnly propiedad en true para recuperar solo los nombres de los atributos a los que se han asignado valores.Set the PropertyNamesOnly property to true to retrieve only the names of attributes to which values have been assigned.

  • Realice una búsqueda paginada.Perform a paged search. Establezca la PageSize propiedad para especificar el número máximo de objetos que se devuelven en una búsqueda paginada.Set the PageSize property to specify the maximum number of objects that are returned in a paged search. Si no desea realizar una búsqueda paginada, establezca la PageSize propiedad en su valor predeterminado de cero.If you do not want to perform a paged search, set the PageSize property to its default of zero.

  • Especifique el número máximo de entradas que se van a devolver SizeLimit con la propiedad.Specify the maximum number of entries to return, using the SizeLimit property. Si establece la SizeLimit propiedad en su valor predeterminado de cero, el valor predeterminado del servidor es 1000 entradas.If you set the SizeLimit property to its default of zero, the server-determined default is 1000 entries.

Nota

Si el número máximo de entradas y límites de tiempo devueltos supera las limitaciones establecidas en el servidor, la configuración del servidor invalidará la configuración del componente.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.

Para obtener una lista con los valores de propiedad iniciales de una instancia de la clase DirectorySearcher, vea el constructor DirectorySearcher().For a list of initial property values for an instance of the DirectorySearcher class, see the DirectorySearcher() constructor.

Nota

Se supone que tiene conocimientos generales sobre Active Directory Domain Services antes de utilizar esta clase.It is assumed that you have a general understanding of Active Directory Domain Services before using this class. Para obtener más información, vea System.DirectoryServices la información general.For more information, see the System.DirectoryServices overview.

Constructores

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

Inicializa una nueva instancia de la clase DirectorySearcher con valores predeterminados.Initializes a new instance of the DirectorySearcher class with default values.

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

Inicializa una nueva instancia de la clase DirectorySearcher utilizando la raíz de búsqueda especificada.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)

Inicializa una nueva instancia de la clase DirectorySearcher con la raíz de búsqueda y el filtro de búsqueda especificados.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[])

Inicializa una nueva instancia de la clase DirectorySearcher con los elementos especificados (la raíz de búsqueda, el filtro de búsqueda y las propiedades que se van a recuperar).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)

Inicializa una nueva instancia de la clase DirectorySearcher con la raíz de búsqueda, el filtro de búsqueda, las propiedades que se van a recuperar y el ámbito de búsqueda especificados.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)

Inicializa una nueva instancia de la clase DirectorySearcher con el filtro de búsqueda especificado.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[])

Inicializa una nueva instancia de la clase DirectorySearcher con el filtro de búsqueda y las propiedades que se van a recuperar especificados.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)

Inicializa una nueva instancia de la clase DirectorySearcher con el filtro de búsqueda, las propiedades que se van a recuperar y el ámbito de búsqueda especificados.Initializes a new instance of the DirectorySearcher class with the specified search filter, properties to retrieve, and search scope.

Propiedades

Asynchronous Asynchronous Asynchronous Asynchronous

Obtiene o establece un valor que indica si la búsqueda se realiza de forma asincrónica.Gets or sets a value that indicates if the search is performed asynchronously.

AttributeScopeQuery AttributeScopeQuery AttributeScopeQuery AttributeScopeQuery

Obtiene o establece el nombre LDAP para mostrar que corresponde al atributo de nombre distintivo en el que se va a realizar la búsqueda.Gets or sets the LDAP display name of the distinguished name attribute to search in. Solo se puede utilizar un atributo para este tipo de búsqueda.Only one attribute can be used for this type of search.

CacheResults CacheResults CacheResults CacheResults

Obtiene o establece un valor que indica si el resultado se almacena en la caché del equipo cliente.Gets or sets a value indicating whether the result is cached on the client computer.

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Obtiene un valor que indica si el componente puede generar un evento.Gets a value indicating whether the component can raise an event.

(Inherited from Component)
ClientTimeout ClientTimeout ClientTimeout ClientTimeout

Obtiene o establece el límite máximo de tiempo que debe esperar el cliente para que el servidor devuelva los resultados.Gets or sets the maximum amount of time that the client waits for the server to return results. Si el servidor no responde dentro de este intervalo de tiempo, se anula la búsqueda y no se devuelve ningún resultado.If the server does not respond within this time, the search is aborted and no results are returned.

Container Container Container Container

Obtiene IContainer que contiene Component.Gets the IContainer that contains the Component.

(Inherited from Component)
DerefAlias DerefAlias DerefAlias DerefAlias

Obtiene o establece un valor que indica cómo se deberían resolver los alias de objetos que se encuentran durante una búsqueda.Gets or sets a value indicating how the aliases of objects that are found during a search should be resolved.

DesignMode DesignMode DesignMode DesignMode

Obtiene un valor que indica si Component está actualmente en modo de diseño.Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
DirectorySynchronization DirectorySynchronization DirectorySynchronization DirectorySynchronization

Obtiene o establece un objeto que representa el control de sincronización de directorios que se utilizará con la búsqueda.Gets or sets an object that represents the directory synchronization control to use with the search.

Events Events Events Events

Obtiene la lista de controladores de eventos asociados a Component.Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
ExtendedDN ExtendedDN ExtendedDN ExtendedDN

Obtiene o establece un valor que indica el formato de los nombres distintivos.Gets or sets a value that indicates the format of the distinguished names.

Filter Filter Filter Filter

Obtiene o establece un valor que indica la cadena de filtro en formato de Protocolo ligero de acceso a directorios (LDAP).Gets or sets a value indicating the Lightweight Directory Access Protocol (LDAP) format filter string.

PageSize PageSize PageSize PageSize

Obtiene o establece un valor que indica el tamaño de página en una búsqueda paginada.Gets or sets a value indicating the page size in a paged search.

PropertiesToLoad PropertiesToLoad PropertiesToLoad PropertiesToLoad

Obtiene un valor que indica la lista de propiedades que se recuperan durante la búsqueda.Gets a value indicating the list of properties to retrieve during the search.

PropertyNamesOnly PropertyNamesOnly PropertyNamesOnly PropertyNamesOnly

Obtiene o establece un valor que indica si la búsqueda va a recuperar sólo los nombres de los atributos a los que se les han asignado valores.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

Obtiene o establece un valor que indica cómo se buscan las referencias.Gets or sets a value indicating how referrals are chased.

SearchRoot SearchRoot SearchRoot SearchRoot

Obtiene o establece un valor que indica el nodo de la jerarquía de los Servicios de dominio de Active Directory donde comienza la búsqueda.Gets or sets a value indicating the node in the Active Directory Domain Services hierarchy where the search starts.

SearchScope SearchScope SearchScope SearchScope

Obtiene o establece un valor que indica el ámbito de la búsqueda al que obedece el servidor.Gets or sets a value indicating the scope of the search that is observed by the server.

SecurityMasks SecurityMasks SecurityMasks SecurityMasks

Obtiene o establece un valor que indica qué información de acceso de seguridad debe devolver la búsqueda para los atributos especificados.Gets or sets a value indicating which security access information for the specified attributes should be returned by the search.

ServerPageTimeLimit ServerPageTimeLimit ServerPageTimeLimit ServerPageTimeLimit

Obtiene o establece un valor que indica el tiempo máximo que el servidor debería buscar una página de resultados dada.Gets or sets a value indicating the maximum amount of time the server should search for an individual page of results. No es igual que el límite de tiempo de toda la búsqueda.This is not the same as the time limit for the entire search.

ServerTimeLimit ServerTimeLimit ServerTimeLimit ServerTimeLimit

La propiedad ServerTimeLimit obtiene o establece un valor que indica el tiempo máximo durante el cual el servidor realiza una búsqueda.The ServerTimeLimit property gets or sets a value indicating the maximum amount of time the server spends searching. Si se alcanza el límite de tiempo, sólo se devuelven las entradas encontradas hasta ese momento.If the time limit is reached, only entries that are found up to that point are returned.

Site Site Site Site

Obtiene o establece el ISite de Component.Gets or sets the ISite of the Component.

(Inherited from Component)
SizeLimit SizeLimit SizeLimit SizeLimit

Obtiene o establece un valor que indica el número máximo de objetos que el servidor devuelve en una búsqueda.Gets or sets a value indicating the maximum number of objects that the server returns in a search.

Sort Sort Sort Sort

Obtiene o establece un valor que indica la propiedad según la cual se ordenan los resultados.Gets or sets a value indicating the property on which the results are sorted.

Tombstone Tombstone Tombstone Tombstone

Obtiene o establece un valor que indica si la búsqueda debe devolver también los objetos eliminados que coincidan con el filtro de búsqueda.Gets or sets a value indicating whether the search should also return deleted objects that match the search filter.

VirtualListView VirtualListView VirtualListView VirtualListView

Obtiene o establece un valor que indica las opciones de vista de lista virtual para la búsqueda.Gets or sets a value indicating the virtual list view options for the search.

Métodos

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

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.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()

Libera todos los recursos que usa Component.Releases all resources used by the Component.

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

Libera los recursos administrados que el objeto DirectorySearcher utiliza y, de forma opcional, libera los recursos no administrados.Releases the managed resources that are used by the DirectorySearcher object and, optionally, releases unmanaged resources.

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

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

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

Ejecuta la búsqueda y devuelve una colección de las entradas que se han encontrado.Executes the search and returns a collection of the entries that are found.

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

Ejecuta la búsqueda y devuelve únicamente la primera entrada encontrada.Executes the search and returns only the first entry that is found.

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

Sirve como la función hash predeterminada.Serves as the default hash function.

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

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.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)

Devuelve un objeto que representa el servicio suministrado por Component o por Container.Returns an object that represents a service provided by the Component or by its Container.

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

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

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

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.Obtains a lifetime service object to control the lifetime policy for this instance.

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

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

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

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

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

Devuelve una String que contiene el nombre del Component, si existe.Returns a String containing the name of the Component, if any. Este método no se debe invalidar.This method should not be overridden.

(Inherited from Component)

Eventos

Disposed Disposed Disposed Disposed

Se produce cuando el componente se elimina mediante una llamada al método Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)

Seguridad

DirectoryServicesPermission
LinkDemand

Se aplica a

Consulte también: