ldap_get_option-Funktion (winldap.h)

Artikel
08/27/2023

Die ldap_get_option-Funktion ruft die aktuellen Werte sitzungsweiter Parameter ab.

Syntax

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

Parameter

[in] ld

Das Sitzungshandle.

[in] option

Der Name der Option, auf die zugegriffen wird. Weitere Informationen und eine Liste der zulässigen Optionen und deren Werte finden Sie im folgenden Abschnitt hinweise.

[out] outvalue

Die Adresse des Optionswerts. Der tatsächliche Typ dieses Parameters hängt von der Einstellung des Optionsparameters ab.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert LDAP_SUCCESS.

Wenn die Ausführung der Funktion fehlschlägt, wird ein Fehlercode zurückgegeben. Weitere Informationen finden Sie unter Rückgabewerte.

Hinweise

Weitere Informationen und eine Beschreibung der optionalen Einstellungen, die für eine LDAP-Sitzung gelten, finden Sie unter Sitzungsoptionen. Der Wert outvalue gibt einen Zeiger auf einen zugeordneten Speicherblock des Typs zurück, der in der Tabelle Sitzungsoptionen aufgeführt ist. Dieser Arbeitsspeicher sollte mit ldap_memfree freigegeben werden, wenn die Daten nicht mehr benötigt werden, es sei denn, er wird explizit in der Tabelle Sitzungsoptionen erwähnt, um den zurückgegebenen Arbeitsspeicher nicht freizugeben.

Beachten SieLDAP_OPT_ERROR_STRING einen Zeiger auf eine interne statische Zeichenfolgentabelle zurückgibt, und ldap_memfree sollte bei Verwendung dieser Sitzungsoption nicht aufgerufen werden.

Multithreading: Die funktion ldap_get_option ist threadsicher.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista
Unterstützte Mindestversion (Server)	Windows Server 2008
Zielplattform	Windows
Kopfzeile	winldap.h
Bibliothek	Wldap32.lib
DLL	Wldap32.dll