DirectorySearcher Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Realiza consultas en los Servicios de dominio de 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
- 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). LDAP es el único proveedor de interfaces de servicio de Active Directory (ADSI) proporcionado por el sistema que admite la búsqueda de directorios. Un administrador puede realizar, modificar y eliminar objetos que se encuentran en la jerarquía. Para obtener más información, vea Uso de System.DirectoryServices.
Al crear una instancia de DirectorySearcher, se especifica la raíz que desea recuperar y una lista opcional de propiedades que se van a recuperar. La SearchRoot propiedad permite establecer propiedades adicionales para realizar las siguientes tareas:
Almacene en caché los resultados de búsqueda en el equipo local. Establezca la CacheResults propiedad
true
en para almacenar información de directorio en el equipo local. Las actualizaciones se realizan en esta caché local y se confirman en Active Directory Domain Services solo cuando se llama al DirectoryEntry.CommitChanges método .Especifique el período de tiempo que se va a buscar mediante la ServerTimeLimit propiedad .
Recupere solo los nombres de atributo. Establezca la PropertyNamesOnly propiedad
true
en para recuperar solo los nombres de los atributos a los que se han asignado valores.Realice una búsqueda paginada. Establezca la PageSize propiedad para especificar el número máximo de objetos que se devuelven en una búsqueda paginada. Si no desea realizar una búsqueda paginada, establezca la PageSize propiedad en su valor predeterminado de cero.
Especifique el número máximo de entradas que se van a devolver mediante la SizeLimit propiedad . Si establece la SizeLimit propiedad en su valor predeterminado de cero, el valor predeterminado determinado por el servidor es 1000 entradas.
Nota
Si el número máximo de entradas devueltas y límites de tiempo superan las limitaciones establecidas en el servidor, la configuración del servidor invalida la configuración del componente.
Para obtener una lista con los valores de propiedad iniciales de una instancia de la clase DirectorySearcher, vea el constructor DirectorySearcher().
Nota
Se supone que tiene conocimientos generales de Active Directory Domain Services antes de usar esta clase. Para más información, consulte el tema de información general de System.DirectoryServices.
Constructores
DirectorySearcher() |
Inicializa una nueva instancia de la clase DirectorySearcher con valores predeterminados. |
DirectorySearcher(DirectoryEntry) |
Inicializa una nueva instancia de la clase DirectorySearcher utilizando la raíz de búsqueda especificada. |
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. |
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). |
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. |
DirectorySearcher(String) |
Inicializa una nueva instancia de la clase DirectorySearcher con el filtro de búsqueda especificado. |
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. |
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. |
Propiedades
Asynchronous |
Obtiene o establece un valor que indica si la búsqueda se realiza de forma asincrónica. |
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. Solo se puede utilizar un atributo para este tipo de búsqueda. |
CacheResults |
Obtiene o establece un valor que indica si el resultado se almacena en la caché del equipo cliente. |
CanRaiseEvents |
Obtiene un valor que indica si el componente puede generar un evento. (Heredado de Component) |
ClientTimeout |
Obtiene o establece el límite máximo de tiempo que debe esperar el cliente para que el servidor devuelva los resultados. Si el servidor no responde dentro de este intervalo de tiempo, se anula la búsqueda y no se devuelve ningún resultado. |
Container |
Obtiene la interfaz IContainer que contiene la clase Component. (Heredado de Component) |
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. |
DesignMode |
Obtiene un valor que indica si Component está actualmente en modo de diseño. (Heredado de Component) |
DirectorySynchronization |
Obtiene o establece un objeto que representa el control de sincronización de directorios que se utilizará con la búsqueda. |
Events |
Obtiene la lista de controladores de eventos asociados a Component. (Heredado de Component) |
ExtendedDN |
Obtiene o establece un valor que indica el formato de los nombres distintivos. |
Filter |
Obtiene o establece un valor que indica la cadena de filtro en formato de Protocolo ligero de acceso a directorios (LDAP). |
PageSize |
Obtiene o establece un valor que indica el tamaño de página en una búsqueda paginada. |
PropertiesToLoad |
Obtiene un valor que indica la lista de propiedades que se recuperan durante la búsqueda. |
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. |
ReferralChasing |
Obtiene o establece un valor que indica cómo se buscan las referencias. |
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. |
SearchScope |
Obtiene o establece un valor que indica el ámbito de la búsqueda al que obedece el servidor. |
SecurityMasks |
Obtiene o establece un valor que indica qué información de acceso de seguridad debe devolver la búsqueda para los atributos especificados. |
ServerPageTimeLimit |
Obtiene o establece un valor que indica el tiempo máximo que el servidor debería buscar una página de resultados dada. No es igual que el límite de tiempo de toda la búsqueda. |
ServerTimeLimit |
La propiedad ServerTimeLimit obtiene o establece un valor que indica el tiempo máximo durante el cual el servidor realiza una búsqueda. Si se alcanza el límite de tiempo, sólo se devuelven las entradas encontradas hasta ese momento. |
Site |
Obtiene o establece ISite de Component. (Heredado de Component) |
SizeLimit |
Obtiene o establece un valor que indica el número máximo de objetos que el servidor devuelve en una búsqueda. |
Sort |
Obtiene o establece un valor que indica la propiedad según la cual se ordenan los resultados. |
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. |
VirtualListView |
Obtiene o establece un valor que indica las opciones de vista de lista virtual para la búsqueda. |
Métodos
CreateObjRef(Type) |
Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto. (Heredado de MarshalByRefObject) |
Dispose() |
Libera todos los recursos que usa Component. (Heredado de Component) |
Dispose(Boolean) |
Libera los recursos administrados que el objeto DirectorySearcher utiliza y, de forma opcional, libera los recursos no administrados. |
Equals(Object) |
Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object) |
FindAll() |
Ejecuta la búsqueda y devuelve una colección de las entradas que se han encontrado. |
FindOne() |
Ejecuta la búsqueda y devuelve únicamente la primera entrada encontrada. |
GetHashCode() |
Sirve como la función hash predeterminada. (Heredado de Object) |
GetLifetimeService() |
Obsoletos.
Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia. (Heredado de MarshalByRefObject) |
GetService(Type) |
Devuelve un objeto que representa el servicio suministrado por Component o por Container. (Heredado de Component) |
GetType() |
Obtiene el Type de la instancia actual. (Heredado de Object) |
InitializeLifetimeService() |
Obsoletos.
Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia. (Heredado de MarshalByRefObject) |
MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
MemberwiseClone(Boolean) |
Crea una copia superficial del objeto MarshalByRefObject actual. (Heredado de MarshalByRefObject) |
ToString() |
Devuelve una String que contiene el nombre del Component, si existe. Este método no se debe invalidar. (Heredado de Component) |
Eventos
Disposed |
Tiene lugar cuando una llamada elimina el componente mediante una llamada al método Dispose(). (Heredado de Component) |