ldap_search-Funktion (winldap.h)

Artikel
03/09/2024

Die ldap_search-Funktion durchsucht das LDAP-Verzeichnis und gibt einen angeforderten Satz von Attributen für jeden übereinstimmenen Eintrag zurück.

Syntax

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

Parameter

[in] ld

Ein Sitzungshandle.

[in] base

Ein Zeiger auf eine NULL-Zeichenfolge, die den distinguished Name des Eintrags enthält, an dem die Suche gestartet werden soll.

[in] scope

Ein Datentyp, der einen der folgenden Werte angibt, um den Suchbereich anzugeben.

LDAP_SCOPE_BASE

Suchen Sie nur den Basiseintrag.

LDAP_SCOPE_ONELEVEL

Durchsuchen Sie alle Einträge in der ersten Ebene unterhalb des Basiseintrags, mit Ausnahme des Basiseintrags.

LDAP_SCOPE_SUBTREE

Durchsuchen Sie den Basiseintrag und alle Einträge in der Struktur unterhalb der Basis.

[in] filter

Ein Zeiger auf eine NULL-Zeichenfolge, die den Suchfilter angibt. Weitere Informationen finden Sie unter Suchfiltersyntax.

[in] attrs

Ein NULL-beendetes Array mit NULL-Zeichenfolgen, die angeben, welche Attribute für jeden übereinstimmenden Eintrag zurückgegeben werden sollen. Übergeben Sie NULL , um verfügbare Attribute abzurufen.

[in] attrsonly

Boolescher Wert, der null sein sollte, wenn sowohl Attributtypen als auch Werte zurückgegeben werden sollen, nonzero, wenn nur Typen erforderlich sind.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie die Nachrichten-ID des Suchvorgangs zurück.

Wenn die Funktion fehlschlägt, gibt sie –1 zurück und legt die Sitzungsfehlerparameter in der LDAP-Datenstruktur fest.

Hinweise

Die ldap_search-Funktion initiiert einen asynchronen Suchvorgang.

Verwenden Sie die ldap_set_option-Funktion mit dem ld-Sitzungshandle , um die Optionen LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT und LDAP_OPT_DEREF festzulegen, die bestimmen, wie die Suche ausgeführt wird. Weitere Informationen finden Sie unter Sitzungsoptionen.

Als asynchrone Funktion gibt ldap_search eine Nachrichten-ID für den Vorgang zurück. Rufen Sie ldap_result mit der Nachrichten-ID auf, um das Ergebnis des Vorgangs zu erhalten. Um einen asynchronen Suchvorgang abzubrechen, bevor er abgeschlossen ist, rufen Sie ldap_abandon auf.

Damit die Funktion die Ergebnisse direkt zurückgibt, verwenden Sie die synchrone Routine-ldap_search_s. Verwenden Sie ldap_search_ext oder ldap_search_ext_s , um Unterstützung für LDAP 3-Server- und Clientsteuerelemente zu implementieren.

Multithreading: Aufrufe von ldap_search sind threadsicher, sofern LdapGetLastError verwendet wird, um den tatsächlichen Sitzungsfehlercode abzurufen, wenn der Funktionsaufruf den Fehlercode -1 zurückgibt.

Hinweis Beim Herstellen einer Verbindung mit einem LDAP 2-Server muss die Anwendung einen Bindungsvorgang ausführen, indem sie eine der ldap_bind - oder ldap_simple_bind-Routinen aufruft, bevor sie andere Vorgänge versucht.

Anforderungen

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