ldap_get_next_page_s-Funktion (winldap.h)

Die ldap_get_next_page_s-Funktion gibt die nächste Seite in einer Sequenz synchroner ausgelagerter Suchergebnisse zurück.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_get_next_page_s(
  [in]  PLDAP       ExternalHandle,
  [in]  PLDAPSearch SearchHandle,
  [in]  l_timeval   *timeout,
  [in]  ULONG       PageSize,
  [out] ULONG       *TotalCount,
  [out] LDAPMessage **Results
);

Parameter

[in] ExternalHandle

Sitzungshandle.

[in] SearchHandle

Suchblockhandle.

[in] timeout

Der Zeitwert in Sekunden, den der Client wartet, bis der Aufruf zurückgegeben wird.

[in] PageSize

Die Anzahl der Einträge, die auf einer einzelnen Seite zurückgegeben werden sollen.

[out] TotalCount

Die Serverschätzung der Gesamtzahl der Einträge im gesamten Resultset. Der Wert 0 gibt an, dass der Server keine Schätzung bereitstellen kann.

[out] Results

Ein Zeiger auf die LDAPMessage-Struktur , die die Ergebnisse enthält.

Rückgabewert

Wenn der Server ein NULL-Cookie (nicht Fortsetzung) zurückgibt, wird der Wert LDAP_NO_RESULTS_RETURNED. Andernfalls signalisiert der Client eine Fortsetzung (mehr Daten verfügbar), indem er LDAP_SUCCESS zurückgibt.

Wenn die Funktion andernfalls fehlschlägt, gibt sie den Fehlercode-Rückgabewert zurück, der sich auf den Fehler bezieht. Weitere Informationen finden Sie unter Rückgabewerte.

Hinweise

Die ldap_get_next_page_s-Funktion ist Teil der Schnittstelle für das einfache, synchrone Paging von Suchergebnissen. Verwenden Sie das Suchhandle, das von einem ersten Aufruf an ldap_search_init_page zurückgegeben wurde, und geben Sie im PageSize-Parameter die Anzahl der auf einer Seite zurückgegebenen Einträge an. Legen Sie PageSize auf Null fest, um eine Suche zu beenden.

Die von ldap_get_next_page_s zurückgegebenen Ergebnisse können wie jedes andere Suchergebnis behandelt werden und sollten nach Abschluss durch Aufrufen ldap_msgfree freigegeben werden.

Beim Analysieren des Resultsets ist es möglich, dass der Server eine leere Ergebnisseite zurückgibt und dennoch mit einem LDAP_SUCCESS Rückgabecode reagiert. Dies gibt an, dass der Server aufgrund eines Timeouts oder eines anderen Grunds keine Ergebnisseite abrufen konnte, die Suchanforderung aber nicht abgeschlossen hat. Das richtige Verhalten in diesem instance besteht darin, ldap_get_next_page_s weiterhin aufzurufen, bis entweder eine andere Ergebnisseite erfolgreich abgerufen, ein Fehlercode zurückgegeben oder LDAP_NO_RESULTS_RETURNED zurückgegeben wird, um anzugeben, dass die Suche abgeschlossen ist.

Verwenden Sie ldap_get_next_page, um ausgelagerte Suchergebnisse asynchron abzurufen.

Wenn ldap_get_next_page_s verwendet wird, ist es nicht erforderlich, dass ldap_get_paged_count aufgerufen wird, um die Anzahl der von einem Server zurückgegebenen ausgelagerten Ergebnisse aufzuzeichnen.

Anforderungen

Siehe auch

Funktionen

LDAPMessage

Rückgabewerte

ldap_get_next_page

ldap_get_paged_count

ldap_msgfree

ldap_search_init_page