fonction ldap_modrdnW (winldap.h)
La fonction ldap_modrdn modifie le nom unique relatif d’une entrée LDAP.
Cette fonction est obsolète et est fournie pour la compatibilité descendante avec les versions antérieures de LDAP. Pour LDAP 3 ou version ultérieure, utilisez les fonctions ldap_rename_ext ou ldap_rename_ext_s.
Syntaxe
WINLDAPAPI ULONG LDAPAPI ldap_modrdnW(
[in] LDAP *ExternalHandle,
[in] const PWSTR DistinguishedName,
[out] const PWSTR NewDistinguishedName
);
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 à modifier.
[out] NewDistinguishedName
Pointeur vers une chaîne terminée par null qui contient le nouveau nom unique relatif pour donner l’entrée.
Valeur de retour
Si la fonction réussit, elle retourne l’ID de message de l’opération de modification.
Si la fonction échoue, elle retourne –1 et définit les paramètres d’erreur de session dans la structure de données LDAP.
Remarques
Utilisez la fonction ldap_modrdn, ou son équivalent synchrone, ldap_modrdn_s, pour modifier le nom d’une entrée LDAP. LDAP 2 prend en charge des fonctionnalités supplémentaires via ldap_modrdn2 et ldap_modrdn2_s.
En tant que fonction asynchrone, ldap_modrdn retourne un ID de message pour l’opération. Appelez ldap_result avec l’ID de message pour obtenir le résultat de l’opération. Pour annuler une opération d’ajout asynchrone avant sa fin, appelez ldap_abandon.
N’oubliez pas que les différentes fonctions ldap_modrdn vous permettent de modifier uniquement le nom unique relatif, qui est le composant le moins significatif du nom unique de l’objet. À compter de la version 3, LDAP fournit l’opération Modifier le protocole Nom unique qui permet un accès plus général aux modifications de nom. Cette fonctionnalité est disponible en appelant ldap_rename_ext ou ldap_rename_ext_s. Ces fonctions sont recommandées, au lieu de la fonction ldap_modrdn, pour modifier un nom d’entrée.
Multithreading : les appels à ldap_modrdn sont thread-safe, à condition que LdapGetLastError soit utilisé pour récupérer le code d’erreur de session réel lorsque l’appel de fonction retourne le code d’échec -1.
Note
L’en-tête winldap.h définit ldap_modrdn en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows Vista |
| serveur minimum pris en charge | Windows Server 2008 |
| plateforme cible | Windows |
| d’en-tête | winldap.h |
| bibliothèque | Wldap32.lib |
| DLL | Wldap32.dll |