fonction ldap_deleteW (winldap.h)

Article
20/11/2024

La fonction ldap_delete supprime une entrée de l’arborescence de répertoires.

Syntaxe

WINLDAPAPI ULONG LDAPAPI ldap_deleteW(
  [in] LDAP        *ld,
  [in] const PWSTR dn
);

Paramètres

[in] ld

Handle de session.

[in] dn

Pointeur vers une chaîne terminée par null qui contient le nom unique de l’entrée à supprimer.

Valeur de retour

Si la fonction réussit, elle retourne l’ID de message de l’opération de suppression.

Si la fonction échoue, la valeur de retour est –1 et la fonction définit les paramètres d’erreur de session dans la structure de données LDAP. Pour récupérer cette valeur, utilisez LdapGetLastError.

Remarques

Appelez ldap_delete pour supprimer une entrée feuille de l’arborescence de répertoires. N’oubliez pas que LDAP ne prend pas en charge la suppression de sous-arborescences entières dans une seule opération. En tant que fonction asynchrone, ldap_delete 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 de suppression asynchrone avant sa fin, appelez ldap_abandon.

Pour que la fonction retourne directement les résultats, utilisez la routine synchrone ldap_delete_s. Utilisez ldap_delete_ext ou ldap_delete_ext_s pour activer la prise en charge des contrôles serveur et client LDAP 3.

Multithreading : les appels à ldap_delete 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.

Remarque Lors de la connexion à un serveur LDAP 2, l’application doit effectuer une opération de liaison, en appelant l’une des routines ldap_bind ou ldap_simple_bind, avant de tenter d’effectuer d’autres opérations.

Notes

L’en-tête winldap.h définit ldap_delete 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