ldap_get_next_page, fonction (winldap.h)

Article
03/04/2024

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

Syntaxe

WINLDAPAPI ULONG LDAPAPI ldap_get_next_page(
  [in]  PLDAP       ExternalHandle,
  [in]  PLDAPSearch SearchHandle,
  [in]  ULONG       PageSize,
  [out] ULONG       *MessageNumber
);

Paramètres

[in] ExternalHandle

Handle de session.

[in] SearchHandle

Handle de bloc de recherche.

[in] PageSize

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

[out] MessageNumber

ID de message pour la demande.

Valeur retournée

Si la fonction réussit, la valeur de retour est LDAP_SUCCESS.

Si la fonction échoue, elle retourne une valeur de retour de code d’erreur. Pour plus d’informations, consultez Valeurs de retour.

Remarques

La fonction ldap_get_next_page fait partie de l’interface pour la pagination simple et asynchrone 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 abandonner une recherche.

N’oubliez pas qu’après chaque appel à ldap_get_next_page, vous devez appeler ldap_get_paged_count pour chaque jeu de résultats retourné par le serveur à l’aide de ldap_result. Cela permet au temps d’exécution LDAP d’enregistrer le cookie que le serveur a transmis pour conserver l’état de recherche. En dehors de l’appel de ldap_get_paged_count, les résultats retournés par ldap_get_next_page 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, n’oubliez pas qu’il est possible pour le serveur de retourner une page vide de résultats tout en répondant toujours avec une valeur 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 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.

Si vous préférez récupérer les résultats de recherche paginés de manière synchrone, utilisez ldap_get_next_page_s.

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