fonction ldap_create_sort_control (winldap.h)
La fonction ldap_create_sort_control est utilisée pour mettre en forme une liste de clés de tri dans un contrôle de recherche. La prise en charge des contrôles est disponible avec LDAP 3, mais si le contrôle de tri est pris en charge ou non dépend du serveur particulier.
Syntaxe
WINLDAPAPI ULONG LDAPAPI ldap_create_sort_control(
[in] PLDAP ExternalHandle,
[in] PLDAPSortKeyA *SortKeys,
[in] UCHAR IsCritical,
[out] PLDAPControlA *Control
);
Paramètres
[in] ExternalHandle
Handle de session.
[in] SortKeys
Pointeur vers un tableau de structures LDAPSortKey . Chaque structure du tableau spécifie le nom d’un attribut à utiliser comme clé de tri, la règle correspondante pour cette clé et indique si l’ordre de tri est croissant ou décroissant.
[in] IsCritical
Avertit le serveur si ce contrôle est critique pour la recherche. 0 ==> FALSE, !0 ==> TRUE.
[out] Control
Pointeur vers le contrôle nouvellement créé.
Valeur retournée
Cette fonction retourne WINLDAPAPI ULONG LDAPAPI.
Remarques
La fonction ldap_create_sort_control crée un contrôle de tri de base. Un tel contrôle est utile lorsque le client LDAP a des fonctionnalités limitées et ne peut pas trier les résultats, mais a besoin de les trier.
Les contrôles de tri permettent à un serveur de retourner un code de résultat pour le tri des résultats qui est indépendant du code de résultat retourné pour l’opération de recherche.
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.
Pour libérer le contrôle lorsqu’il n’est plus nécessaire, appelez ldap_control_free.
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 |