fonction ldap_create_page_control (winldap.h)
Utilisez la fonction ldap_create_page_control pour créer un contrôle de base pour la pagination des résultats. La prise en charge des contrôles est disponible avec LDAP 3, mais si le contrôle de page est pris en charge ou non dépend du serveur particulier.
Syntaxe
WINLDAPAPI ULONG LDAPAPI ldap_create_page_control(
[in] PLDAP ExternalHandle,
[in] ULONG PageSize,
[in] berval *Cookie,
[in] UCHAR IsCritical,
[out] PLDAPControlA *Control
);
Paramètres
[in] ExternalHandle
Handle de session.
[in] PageSize
Nombre d’entrées à retourner dans chaque page.
[in] Cookie
Pointeur vers une structure berval que le serveur utilise pour déterminer son emplacement dans le jeu de résultats. Il s’agit d’une structure opaque à laquelle vous ne devez pas accéder directement. Définissez la valeur NULL pour le premier appel à ldap_create_page_control.
[in] IsCritical
Avertit le serveur si ce contrôle est critique pour la recherche.
[out] Control
Pointeur vers le contrôle nouvellement créé.
Valeur retournée
Cette fonction retourne WINLDAPAPI ULONG LDAPAPI.
Remarques
La fonction ldap_create_page_control crée un contrôle paginé-results simple. Le contrôle permet au client de spécifier la vitesse à laquelle un serveur LDAP retourne les résultats d’une opération de recherche. Cela est utile lorsque le client a des ressources limitées et peut ne pas être en mesure de traiter l’ensemble du jeu de résultats à partir d’une requête LDAP donnée, ou lorsque la connexion client/serveur est lente.
Pour créer le contrôle paginé-results, spécifiez le nombre d’entrées à retourner dans une seule page. Pour retourner des résultats normalement, même s’il ne peut pas prendre en charge ce contrôle, définissez le paramètre IsCritical sur FALSE.
Cette fonction crée le contrôle : elle ne vérifie pas que le serveur le prend en charge et, par conséquent, ne retourne pas LDAP_UNAVAILABLE_CRIT_EXTENSION si le serveur ne prend pas en charge le contrôle. Toutefois, il peut retourner d’autres valeurs de retour LDAP standard, telles que LDAP_NO_MEMORY ou LDAP_PARAM_ERROR.
Lorsque ldap_create_page_control retourne correctement, incluez le contrôle nouvellement créé à la liste des contrôles serveur dans un appel à ldap_search_ext ou à ldap_search_ext_s. Lorsque le serveur retourne la première page de résultats, appelez ldap_parse_result pour récupérer la première page de résultats.
Appelez ldap_control_free lorsque le contrôle n’est plus requis.
Configuration requise
| 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 |