ldap_create_page_control-Funktion (winldap.h)

Verwenden Sie die ldap_create_page_control-Funktion , um ein grundlegendes Steuerelement für Pagingergebnisse zu erstellen. Die Unterstützung für Steuerelemente ist ab LDAP 3 verfügbar, aber ob das Seitensteuerelement unterstützt wird oder nicht, hängt vom jeweiligen Server ab.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_create_page_control(
  [in]  PLDAP         ExternalHandle,
  [in]  ULONG         PageSize,
  [in]  berval        *Cookie,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Parameter

[in] ExternalHandle

Das Sitzungshandle.

[in] PageSize

Die Anzahl von Einträgen, die auf jeder Seite zurückgegeben werden sollen.

[in] Cookie

Zeiger auf eine berval-Struktur , die der Server verwendet, um seinen Speicherort im Resultset zu bestimmen. Dies ist eine undurchsichtige Struktur, auf die Sie nicht direkt zugreifen sollten. Legen Sie für den ersten Aufruf von ldap_create_page_control auf NULL fest.

[in] IsCritical

Benachrichtigt den Server, ob dieses Steuerelement für die Suche wichtig ist.

[out] Control

Zeiger auf das neu erstellte Steuerelement.

Rückgabewert

Diese Funktion gibt WINLDAPAPI ULONG LDAPAPI zurück.

Hinweise

Die ldap_create_page_control-Funktion erstellt ein einfaches Auslagerungsergebnis-Steuerelement. Das -Steuerelement ermöglicht es dem Client, die Rate anzugeben, mit der ein LDAP-Server die Ergebnisse eines Suchvorgangs zurückgibt. Dies ist nützlich, wenn der Client über begrenzte Ressourcen verfügt und möglicherweise nicht das gesamte Resultset aus einer bestimmten LDAP-Abfrage verarbeiten kann oder wenn die Client/Server-Verbindung langsam ist.

Geben Sie zum Erstellen des Paged-Results-Steuerelements die Anzahl der Einträge an, die auf einer einzelnen Seite zurückgegeben werden sollen. Legen Sie den IsCritical-Parameter auf FALSE fest, um ergebnisse normal zurückzugeben, auch wenn es dieses Steuerelement nicht unterstützen kann.

Diese Funktion erstellt das Steuerelement. Sie überprüft nicht, ob der Server es unterstützt, und gibt daher nicht LDAP_UNAVAILABLE_CRIT_EXTENSION zurück, wenn der Server das Steuerelement nicht unterstützt. Es kann jedoch andere LDAP-Standardrückgabewerte zurückgeben, z. B. LDAP_NO_MEMORY oder LDAP_PARAM_ERROR.

Wenn ldap_create_page_control erfolgreich zurückgegeben wird, schließen Sie das neu erstellte Steuerelement in die Liste der Serversteuerelemente in einen Aufruf von ldap_search_ext oder ldap_search_ext_s ein. Wenn der Server die erste Ergebnisseite zurückgibt, rufen Sie ldap_parse_result auf, um die erste Seite der Ergebnisse abzurufen.

Rufen Sie ldap_control_free auf, wenn das Steuerelement nicht mehr benötigt wird.

Anforderungen

Siehe auch

Funktionen

LDAP_PAGED_RESULT_OID_STRING

ldap_control_free

ldap_parse_page_control

ldap_parse_result

ldap_search_ext

ldap_search_ext_s