ldap_get_next_page_s, fonction (winldap.h)

Article
03/13/2024

La fonction ldap_get_next_page_s retourne la page suivante dans une séquence de résultats de recherche paginés synchrones.

Syntaxe

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
);

Paramètres

[in] ExternalHandle

Handle de session.

[in] SearchHandle

Handle de bloc de recherche.

[in] timeout

Valeur de temps, en secondes, que le client attend que l’appel retourne.

[in] PageSize

Nombre d’entrées à retourner dans une seule page.

[out] TotalCount

Estimation du serveur du nombre total d’entrées dans l’ensemble du jeu de résultats. La valeur zéro indique que le serveur ne peut pas fournir d’estimation.

[out] Results

Pointeur vers la structure LDAPMessage qui contient les résultats.

Valeur retournée

Si le serveur retourne un cookie Null (sans continuation), la valeur est LDAP_NO_RESULTS_RETURNED. Sinon, le client signale une continuation (plus de données disponibles) en retournant LDAP_SUCCESS.

Si la fonction échoue, elle retourne la valeur de retour du code d’erreur liée à l’échec. Pour plus d’informations, consultez Valeurs de retour.

Remarques

La fonction ldap_get_next_page_s fait partie de l’interface permettant une pagination synchrone simple des résultats de la recherche. Utilisez le handle de recherche retourné à partir d’un appel initial à ldap_search_init_page et spécifiez, dans le paramètre PageSize , le nombre d’entrées à retourner dans une page. Définissez PageSize sur zéro pour quitter une recherche.

Les résultats retournés par ldap_get_next_page_s peuvent être gérés comme n’importe quel autre résultat de recherche et doivent être libérés, lorsque vous avez terminé, en appelant ldap_msgfree.

Lors de l’analyse du jeu de résultats, il est possible pour le serveur de retourner une page vide de résultats tout en répondant toujours avec un code de retour LDAP_SUCCESS . Cela indique que le serveur n’a pas pu récupérer une page de résultats, en raison d’un délai d’expiration ou d’une autre raison, mais qu’il n’a pas terminé la demande de recherche. Le comportement approprié dans cette instance consiste à continuer à appeler ldap_get_next_page_s jusqu’à ce qu’une autre page de résultats soit récupérée, qu’un code d’erreur soit retourné ou qu’LDAP_NO_RESULTS_RETURNED soit retourné pour indiquer que la recherche est terminée.

Pour récupérer le résultat de recherche paginé de manière asynchrone, utilisez ldap_get_next_page.

Si ldap_get_next_page_s est utilisé, il n’est pas nécessaire qu’ldap_get_paged_count soit appelé pour enregistrer le nombre de résultats paginés retournés par un serveur.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista
Serveur minimal pris en charge	Windows Server 2008
Plateforme cible	Windows
En-tête	winldap.h
Bibliothèque	Wldap32.lib
DLL	Wldap32.dll