fonction ldap_search_init_page (winldap.h)
La fonction ldap_search_init_page initialise un bloc de recherche pour une recherche de résultats paginés simple. Cette fonction est prise en charge dans LDAP 3.
Syntaxe
WINLDAPAPI PLDAPSearch LDAPAPI ldap_search_init_page(
[in] PLDAP ExternalHandle,
[in] const PSTR DistinguishedName,
[in] ULONG ScopeOfSearch,
[in] const PSTR SearchFilter,
[in] PZPSTR AttributeList,
[in] ULONG AttributesOnly,
[in] PLDAPControl *ServerControls,
[in] PLDAPControl *ClientControls,
[in] ULONG PageTimeLimit,
[in] ULONG TotalSizeLimit,
[in] PLDAPSortKey *SortKeys
);
Paramètres
[in] ExternalHandle
Handle de session.
[in] DistinguishedName
Pointeur vers une chaîne terminée par null qui contient le nom unique de l’entrée à partir de laquelle démarrer la recherche.
[in] ScopeOfSearch
Type de données qui spécifie l’une des valeurs suivantes pour indiquer l’étendue de la recherche.
LDAP_SCOPE_BASE
Recherchez uniquement dans l’entrée de base.
LDAP_SCOPE_ONELEVEL
Recherchez toutes les entrées du premier niveau sous l’entrée de base, à l’exclusion de l’entrée de base.
LDAP_SCOPE_SUBTREE
Recherchez l’entrée de base et toutes les entrées dans l’arborescence située sous la base.
[in] SearchFilter
Pointeur vers une chaîne terminée par null qui spécifie le filtre de recherche. Pour plus d’informations, consultez Syntaxe de filtre de recherche.
[in] AttributeList
Tableau terminé par null de chaînes terminées par null indiquant les attributs à retourner pour chaque entrée correspondante. Passez la valeur NULL pour récupérer tous les attributs disponibles.
[in] AttributesOnly
Valeur booléenne qui doit être égale à zéro si les types d’attributs et les valeurs doivent être retournés, différente de zéro si seuls les types doivent être retournés.
[in] ServerControls
Liste des contrôles serveur LDAP.
[in] ClientControls
Liste des contrôles clients.
[in] PageTimeLimit
Valeur de temps, en secondes, pendant laquelle le client attend que le serveur retourne une page.
[in] TotalSizeLimit
Nombre maximal d’entrées que le client acceptera. La valeur TotalSizeLimit affecte uniquement les pages individuelles de la recherche paginée (et non la recherche paginée globale). Par conséquent, si TotalSizeLimit est supérieur à la taille de page, TotalSizeLimit n’aura aucun effet.
[in] SortKeys
Pointeur vers une structure LDAPSortKey , qui spécifie le type d’attribut, la règle de classement et la direction de la recherche.
Valeur retournée
Si la fonction réussit, elle retourne un pointeur vers une structure LDAPSearch .
Si la fonction échoue, la valeur de retour est NULL. Utilisez LdapGetLastError ou GetLastError pour récupérer le code d’erreur.
Appelez le ldap_search_abandon_page pour libérer la structure retournée.
Remarques
La fonction ldap_search_init_page crée une structure LDAPSearch pour la gestion des recherches paginées et retourne un handle à la structure. Les fonctions ldap_get_next_page, ldap_get_next_page_s et ldap_get_paged_count nécessitent ce handle de recherche en tant que paramètre. Une fois la recherche paginée terminée, appelez ldap_search_abandon_page pour libérer cette structure et son handle.
Pour déterminer si un serveur prend en charge les recherches paginées-résultats, case activée la propriété supportedControl hors de la racine pour un identificateur d’objet (OID) de 1.2.840.113556.1.4.319.
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 |