ldap_search, fonction (winldap.h)

Article
03/13/2024

La fonction ldap_search recherche dans le répertoire LDAP et retourne un ensemble d’attributs demandé pour chaque entrée correspondante.

Syntaxe

WINLDAPAPI ULONG LDAPAPI ldap_search(
  [in] LDAP   *ld,
  [in] PSTR   base,
  [in] ULONG  scope,
  [in] PSTR   filter,
  [in] PZPSTR attrs,
  [in] ULONG  attrsonly
);

Paramètres

[in] ld

Handle de session.

[in] base

Pointeur vers une chaîne terminée par un caractère Null qui contient le nom unique de l’entrée à partir de laquelle commencer la recherche.

[in] scope

Type de données qui spécifie l’une des valeurs suivantes pour indiquer l’étendue de la recherche.

LDAP_SCOPE_BASE

Recherchez uniquement l’entrée de base.

LDAP_SCOPE_ONELEVEL

Recherchez toutes les entrées du premier niveau sous l’entrée de base, à l’exclusion de l’entrée de base.

LDAP_SCOPE_SUBTREE

Recherchez l’entrée de base et toutes les entrées de l’arborescence sous la base.

[in] filter

Pointeur vers une chaîne terminée par null qui spécifie le filtre de recherche. Pour plus d’informations, consultez Syntaxe des filtres de recherche.

[in] attrs

Tableau de chaînes terminées par null qui indiquent les attributs à retourner pour chaque entrée correspondante. Passez la valeur NULL pour récupérer les attributs disponibles.

[in] attrsonly

Valeur booléenne qui doit être égale à zéro si les types d’attributs et les valeurs doivent être retournés, différente de zéro si seuls les types sont requis.

Valeur retournée

Si la fonction réussit, elle retourne l’ID de message de l’opération de recherche.

Si la fonction échoue, elle retourne –1 et définit les paramètres d’erreur de session dans la structure de données LDAP.

Remarques

La fonction ldap_search lance une opération de recherche asynchrone.

Utilisez la fonction ldap_set_option avec le handle de session ld pour définir les options LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT et LDAP_OPT_DEREF qui déterminent la façon dont la recherche est effectuée. Pour plus d’informations, consultez Options de session.

En tant que fonction asynchrone, ldap_search retourne un ID de message pour l’opération. Appelez ldap_result avec l’ID de message pour obtenir le résultat de l’opération. Pour annuler une opération de recherche asynchrone avant qu’elle ne soit terminée, appelez ldap_abandon.

Pour que la fonction retourne directement les résultats, utilisez la routine synchrone ldap_search_s. Utilisez ldap_search_ext ou ldap_search_ext_s pour implémenter la prise en charge des contrôles client et serveur LDAP 3.

Multithreading : les appels à ldap_search sont thread-safe, à condition que LdapGetLastError soit utilisé pour récupérer le code d’erreur de session réel lorsque l’appel de fonction retourne le code d’échec -1.

Note Lors de la connexion à un serveur LDAP 2, l’application doit effectuer une opération de liaison, en appelant l’une des routines ldap_bind ou ldap_simple_bind , avant de tenter d’autres opérations.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista
Serveur minimal pris en charge	Windows Server 2008
Plateforme cible	Windows
En-tête	winldap.h
Bibliothèque	Wldap32.lib
DLL	Wldap32.dll