ldap_get_option, fonction (winldap.h)

Article
08/27/2023

La fonction ldap_get_option récupère les valeurs actuelles des paramètres à l’échelle de la session.

Syntaxe

WINLDAPAPI ULONG LDAPAPI ldap_get_option(
  [in]  LDAP *ld,
  [in]  int  option,
  [out] void *outvalue
);

Paramètres

[in] ld

Handle de session.

[in] option

Nom de l’option consultée. Pour plus d’informations et une liste des options autorisées et leurs valeurs, consultez la section Remarques suivante.

[out] outvalue

Adresse de la valeur d’option. Le type réel de ce paramètre dépend du paramètre d’option.

Valeur retournée

Si la fonction réussit, la valeur de retour est LDAP_SUCCESS.

Si la fonction échoue, elle retourne un code d'erreur. Pour plus d’informations, consultez Valeurs de retour.

Remarques

Pour plus d’informations et une description des paramètres facultatifs qui s’appliquent à une session LDAP, consultez Options de session. La valeur d’outvalue retourne un pointeur vers un bloc de mémoire alloué du type répertorié dans le tableau Options de session ; cette mémoire doit être libérée à l’aide de ldap_memfree lorsque les données ne sont plus nécessaires, sauf si elles sont explicitement mentionnées dans le tableau Options de session pour ne pas libérer la mémoire retournée.

NotezLDAP_OPT_ERROR_STRING retourne un pointeur vers une table de chaînes statique interne, et ldap_memfree ne doit pas être appelée lors de l’utilisation de cette option de session.

Multithreading : la fonction ldap_get_option est thread-safe.

Configuration requise


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