DirectorySearcher Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Effectue des requêtes sur des services de domaine 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
- Héritage
- Attributs
Remarques
Utilisez un DirectorySearcher objet pour rechercher et exécuter des requêtes sur une hiérarchie des services de domaine Active Directory à l’aide du protocole LDAP (Lightweight Directory Access Protocol). LDAP est le seul fournisseur ADSI (Active Directory Service Interfaces) fourni par le système qui prend en charge la recherche d’annuaires. Un administrateur peut créer, modifier et supprimer des objets qui se trouvent dans la hiérarchie. Pour plus d’informations, consultez Utilisation de System.DirectoryServices.
Lorsque vous créez une instance de DirectorySearcher, vous spécifiez la racine que vous souhaitez récupérer et une liste facultative de propriétés à récupérer. La SearchRoot propriété vous permet de définir des propriétés supplémentaires pour effectuer les tâches suivantes :
Mettre en cache les résultats de la recherche sur l’ordinateur local. Définissez la CacheResults propriété
true
sur pour stocker les informations de répertoire sur l’ordinateur local. Les mises à jour sont effectuées dans ce cache local et validées dans les services de domaine Active Directory uniquement lorsque la DirectoryEntry.CommitChanges méthode est appelée.Spécifiez la durée de la recherche à l’aide de la ServerTimeLimit propriété .
Récupérez uniquement les noms d’attributs. Définissez la PropertyNamesOnly propriété sur
true
pour récupérer uniquement les noms des attributs auxquels des valeurs ont été attribuées.Effectuez une recherche paginée. Définissez la PageSize propriété pour spécifier le nombre maximal d’objets retournés dans une recherche paginée. Si vous ne souhaitez pas effectuer de recherche paginée, définissez la PageSize propriété sur zéro par défaut.
Spécifiez le nombre maximal d’entrées à retourner à l’aide de la SizeLimit propriété . Si vous définissez la SizeLimit propriété sur la valeur par défaut zéro, la valeur par défaut déterminée par le serveur est de 1 000 entrées.
Notes
Si le nombre maximal d’entrées retournées et les limites de temps dépassent les limitations définies sur le serveur, les paramètres du serveur remplacent les paramètres du composant.
Pour obtenir la liste des valeurs de propriété initiales d'une instance de la classe DirectorySearcher, consultez le constructeur DirectorySearcher().
Notes
Il est supposé que vous avez une compréhension générale des services de domaine Active Directory avant d’utiliser cette classe. Pour plus d’informations, consultez la vue d’ensemble System.DirectoryServices .
Constructeurs
DirectorySearcher() |
Initialise une nouvelle instance de la classe DirectorySearcher avec les valeurs par défaut. |
DirectorySearcher(DirectoryEntry) |
Initialise une nouvelle instance de la classe DirectorySearcher à l'aide de la racine de recherche spécifiée. |
DirectorySearcher(DirectoryEntry, String) |
Initialise une nouvelle instance de la classe DirectorySearcher avec la racine et le filtre de recherche spécifiés. |
DirectorySearcher(DirectoryEntry, String, String[]) |
Initialise une nouvelle instance de la classe DirectorySearcher avec la racine de recherche, le filtre de recherche et les propriétés à récupérer spécifiés. |
DirectorySearcher(DirectoryEntry, String, String[], SearchScope) |
Initialise une nouvelle instance de la classe DirectorySearcher avec la racine de recherche, le filtre de recherche, les propriétés à récupérer et la zone de recherche spécifiés. |
DirectorySearcher(String) |
Initialise une nouvelle instance de la classe DirectorySearcher avec le filtre de recherche spécifié. |
DirectorySearcher(String, String[]) |
Initialise une nouvelle instance de la classe DirectorySearcher avec le filtre de recherche et les propriétés à récupérer spécifiés. |
DirectorySearcher(String, String[], SearchScope) |
Initialise une nouvelle instance de la classe DirectorySearcher avec le filtre de recherche, les propriétés à récupérer et la zone de recherche spécifiés. |
Propriétés
Asynchronous |
Obtient ou définit une valeur qui indique si la recherche est réalisée de manière asynchrone. |
AttributeScopeQuery |
Obtient ou définit le nom complet LDAP de l'attribut de nom unique dans lequel effectuer une recherche. Un seul attribut peut être utilisé pour ce type de recherche. |
CacheResults |
Obtient ou définit une valeur indiquant si le résultat est mis en cache sur l'ordinateur client. |
CanRaiseEvents |
Obtient une valeur qui indique si le composant peut déclencher un événement. (Hérité de Component) |
ClientTimeout |
Obtient ou définit le délai maximal durant lequel le client attend le retour des résultats par le serveur. Si le serveur ne répond pas avant l'expiration de ce délai, la recherche est abandonnée et aucun résultat n'est retourné. |
Container |
Obtient le IContainer qui contient la Component. (Hérité de Component) |
DerefAlias |
Obtient ou définit une valeur indiquant de quelle manière les alias d'objets qui sont trouvés au cours d'une recherche doivent être résolus. |
DesignMode |
Obtient une valeur qui indique si Component est actuellement en mode design. (Hérité de Component) |
DirectorySynchronization |
Obtient ou définit un objet qui représente le contrôle de synchronisation d'annuaires à utiliser avec la recherche. |
Events |
Obtient la liste des gestionnaires d'événements attachés à ce Component. (Hérité de Component) |
ExtendedDN |
Obtient ou définit une valeur qui indique le format des noms uniques. |
Filter |
Obtient ou définit une valeur indiquant la chaîne de filtrage au format LDAP (Lightweight Directory Access Protocol). |
PageSize |
Obtient ou définit une valeur indiquant la taille de la page dans une recherche paginée. |
PropertiesToLoad |
Obtient une valeur indiquant la liste de propriétés à récupérer au cours de la recherche. |
PropertyNamesOnly |
Obtient ou définit une valeur indiquant si la recherche récupère uniquement les noms des attributs auxquels des valeurs ont été assignées. |
ReferralChasing |
Obtient ou définit une valeur indiquant comment les références sont repérées. |
SearchRoot |
Obtient ou définit une valeur qui indique le nœud dans la hiérarchie des services de domaine Active Directory où la recherche démarre. |
SearchScope |
Obtient ou définit une valeur indiquant la zone de recherche observée par le serveur. |
SecurityMasks |
Obtient ou définit une valeur indiquant quelles informations d'accès de sécurité pour les attributs spécifiés doivent être retournées par la recherche. |
ServerPageTimeLimit |
Obtient ou définit une valeur indiquant la durée maximale pendant laquelle le serveur doit rechercher une page individuelle de résultats. Il ne s'agit pas du délai de la recherche entière. |
ServerTimeLimit |
La propriété ServerTimeLimit obtient ou définit une valeur indiquant la durée maximale de la recherche par le serveur. Une fois ce délai atteint, seules les entrées trouvées jusqu'à cet instant sont retournées. |
Site |
Obtient ou définit le ISite de Component. (Hérité de Component) |
SizeLimit |
Obtient ou définit une valeur indiquant le nombre maximal d'objets retournés par le serveur au cours d'une recherche. |
Sort |
Obtient ou définit une valeur indiquant la propriété sur laquelle les résultats sont stockés. |
Tombstone |
Obtient ou définit une valeur indiquant si la recherche doit également retourner les objets supprimés qui correspondent au filtre de recherche. |
VirtualListView |
Obtient ou définit une valeur indiquant les options de vue de liste virtuelle de la recherche. |
Méthodes
CreateObjRef(Type) |
Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject) |
Dispose() |
Libère toutes les ressources utilisées par Component. (Hérité de Component) |
Dispose(Boolean) |
Libère les ressources managées utilisées par l'objet DirectorySearcher et libère éventuellement les ressources non managées. |
Equals(Object) |
Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object) |
FindAll() |
Exécute la recherche et retourne une collection contenant les entrées trouvées. |
FindOne() |
Exécute la recherche et retourne uniquement la première entrée trouvée. |
GetHashCode() |
Fait office de fonction de hachage par défaut. (Hérité de Object) |
GetLifetimeService() |
Obsolète.
Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject) |
GetService(Type) |
Retourne un objet qui représente un service fourni par Component ou par son Container. (Hérité de Component) |
GetType() |
Obtient le Type de l'instance actuelle. (Hérité de Object) |
InitializeLifetimeService() |
Obsolète.
Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject) |
MemberwiseClone() |
Crée une copie superficielle du Object actuel. (Hérité de Object) |
MemberwiseClone(Boolean) |
Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject) |
ToString() |
Retourne un String contenant le nom du Component, s’il en existe un. Cette méthode ne doit pas être remplacée. (Hérité de Component) |
Événements
Disposed |
Se produit lorsque le composant est supprimé par un appel à la méthode Dispose(). (Hérité de Component) |