funzione ldap_get_option (winldap.h)

La funzione ldap_get_option recupera i valori correnti dei parametri a livello di sessione.

Sintassi

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

Parametri

[in] ld

Handle di sessione.

[in] option

Nome dell'opzione a cui si accede. Per altre informazioni e un elenco delle opzioni consentite e dei relativi valori, vedere la sezione Osservazioni seguente.

[out] outvalue

Indirizzo del valore dell'opzione. Il tipo effettivo di questo parametro dipende dall'impostazione del parametro di opzione.

Valore restituito

Se la funzione ha esito positivo, il valore restituito viene LDAP_SUCCESS.

Se la funzione non viene completata, restituisce un codice di errore. Per altre informazioni, vedere Valori restituiti.

Commenti

Per altre informazioni e una descrizione delle impostazioni facoltative applicabili a una sessione LDAP, vedere Opzioni di sessione. Il valore outvalue restituisce un puntatore a un blocco allocato di memoria del tipo elencato nella tabella Opzioni sessione ; questa memoria deve essere liberata usando ldap_memfree quando i dati non sono più necessari, a meno che non sia indicato in modo esplicito nella tabella Opzioni sessione non liberare la memoria restituita.

NotaLDAP_OPT_ERROR_STRING restituisce un puntatore a una tabella di stringhe statiche interna e ldap_memfree non deve essere chiamato quando si usa questa opzione di sessione.
 
Multithreading: la funzione ldap_get_option è thread-safe.

Requisiti

   
Client minimo supportato Windows Vista
Server minimo supportato Windows Server 2008
Piattaforma di destinazione Windows
Intestazione winldap.h
Libreria Wldap32.lib
DLL Wldap32.dll

Vedi anche

Funzioni

Recupero e impostazione delle opzioni di sessione

Valori restituiti

Opzioni sessione

ldap_memfree

ldap_set_option