ldap_search_init_page-Funktion (winldap.h)

Die ldap_search_init_page-Funktion initialisiert einen Suchblock für eine einfache Suche mit Seitenergebnissen. Diese Funktion wird in LDAP 3 unterstützt.

Syntax

WINLDAPAPI PLDAPSearch LDAPAPI ldap_search_init_page(
  [in] PLDAP        ExternalHandle,
  [in] const PSTR   DistinguishedName,
  [in] ULONG        ScopeOfSearch,
  [in] const PSTR   SearchFilter,
  [in] PZPSTR       AttributeList,
  [in] ULONG        AttributesOnly,
  [in] PLDAPControl *ServerControls,
  [in] PLDAPControl *ClientControls,
  [in] ULONG        PageTimeLimit,
  [in] ULONG        TotalSizeLimit,
  [in] PLDAPSortKey *SortKeys
);

Parameter

[in] ExternalHandle

Das Sitzungshandle.

[in] DistinguishedName

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

[in] ScopeOfSearch

Ein Datentyp, der einen der folgenden Werte angibt, um den Bereich der Suche 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] SearchFilter

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

[in] AttributeList

Ein Array mit NULL-Terminierung von NULL-Zeichenfolgen, die angibt, welche Attribute für jeden übereinstimmenden Eintrag zurückgegeben werden sollen. Übergeben Sie NULL , um alle verfügbaren Attribute abzurufen.

[in] AttributesOnly

Ein boolescher Wert, der null sein sollte, wenn sowohl Attributtypen als auch Werte zurückgegeben werden sollen, ungleich null, wenn nur Typen zurückgegeben werden sollen.

[in] ServerControls

Eine Liste der LDAP-Serversteuerelemente.

[in] ClientControls

Eine Liste der Clientsteuerelemente.

[in] PageTimeLimit

Der Zeitwert in Sekunden, auf den der Client wartet, bis der Server eine Seite zurückgibt.

[in] TotalSizeLimit

Die maximale Anzahl von Einträgen, die der Client akzeptiert. Der TotalSizeLimit-Wert wirkt sich nur auf die einzelnen Seiten innerhalb der Seitensuche aus (nicht auf die gesamte Seitensuche). Wenn TotalSizeLimit also größer als die Seitengröße ist, hat TotalSizeLimit keine Auswirkungen.

[in] SortKeys

Ein Zeiger auf eine LDAPSortKey-Struktur , die den Attributtyp, die Reihenfolgenregel und die Richtung für die Suche angibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird ein Zeiger auf eine LDAPSearch-Struktur zurückgegeben.

Wenn bei der Funktion ein Fehler auftritt, ist der Rückgabewert NULL. Verwenden Sie LdapGetLastError oder GetLastError , um den Fehlercode abzurufen.

Rufen Sie die ldap_search_abandon_page auf, um die zurückgegebene Struktur freizugeben.

Hinweise

Die funktion ldap_search_init_page erstellt eine LDAPSearch-Struktur zum Verwalten von Auslagerungssuchen und gibt ein Handle an die Struktur zurück. Die Funktionen ldap_get_next_page, ldap_get_next_page_s und ldap_get_paged_count erfordern dieses Suchhandle als Parameter. Wenn die Auslagerungssuche abgeschlossen ist, rufen Sie ldap_search_abandon_page auf, um diese Struktur und ihr Handle frei zu geben.

Überprüfen Sie die supportedControl-Eigenschaft aus dem Stamm auf einen Objektbezeichner (OID) von 1.2.840.113556.1.1.4.319, um festzustellen, ob ein Server Seitenergebnisse unterstützt.

Anforderungen

Siehe auch

Funktionen

GetLastError

LDAPSearch

LDAPSortKey

LdapGetLastError

ldap_get_next_page

ldap_get_next_page_s

ldap_search_abandon_page