RemoveDirectoryA, fonction (fileapi.h)
Supprime un répertoire vide existant.
Pour effectuer cette opération en tant qu’opération traitée, utilisez la fonction RemoveDirectoryTransacted .
Syntaxe
BOOL RemoveDirectoryA(
[in] LPCSTR lpPathName
);
Paramètres
[in] lpPathName
Chemin d’accès du répertoire à supprimer. Ce chemin d’accès doit spécifier un répertoire vide et le processus appelant doit disposer d’un accès de suppression au répertoire.
Par défaut, le nom est limité à MAX_PATH caractères. Pour étendre cette limite à 32 767 caractères larges, ajoutez « \\ ?\ » au chemin d’accès. Pour plus d’informations, consultez Nommage de fichiers, de chemins et d’espaces de noms.
Conseil
À compter de Windows 10 version 1607, vous pouvez choisir de supprimer la limitation MAX_PATH sans précédencer « \\ ?\ ». Pour plus d’informations, consultez la section « Limitation maximale de la longueur du chemin d’accès » de Naming Files, Paths et Namespaces .
Valeur retournée
Si la fonction réussit, la valeur de retour est différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.
Remarques
La fonction RemoveDirectory marque un répertoire à supprimer lors de la fermeture. Par conséquent, le répertoire n’est pas supprimé tant que le dernier handle du répertoire n’est pas fermé.
Pour supprimer de manière récursive les fichiers d’un répertoire, utilisez la fonction SHFileOperation .
RemoveDirectory peut être utilisé pour supprimer une jonction de répertoire. Étant donné que le répertoire cible et son contenu restent accessibles via son chemin canonique, le répertoire cible lui-même n’est pas affecté par la suppression d’une jonction qui le cible. Pour cette raison, lorsque lpPathName fait référence à une jonction de répertoire, RemoveDirectory supprime le lien spécifié, que le répertoire cible soit vide ou non. Pour plus d’informations sur les jonctions, consultez Liens durs et jonctions.
L’utilisation de la suppression POSIX entraîne la suppression du répertoire tant que les handles restent ouverts. Les appels suivants à CreateDirectory pour ouvrir le répertoire échouent avec ERROR_FILE_NOT_FOUND.
Dans Windows 8 et Windows Server 2012, cette fonction est prise en charge par les technologies suivantes :
| Technologie | Prise en charge |
|---|---|
| Protocole Server Message Block (SMB) 3.0 | Oui |
| Basculement transparent SMB 3.0 (TFO) | Oui |
| SMB 3.0 avec partages de fichiers avec montée en puissance parallèle (SO) | Oui |
| Système de fichiers du volume partagé de cluster (CsvFS) | Oui |
| Système de fichiers résilient (ReFS) | Oui |
Notes
L’en-tête fileapi.h définit RemoveDirectory comme un 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.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows XP [applications de bureau | applications UWP] |
| Serveur minimal pris en charge | Windows Server 2003 [applications de bureau | applications UWP] |
| Plateforme cible | Windows |
| En-tête | fileapi.h (inclure Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |
Voir aussi
Création et suppression de répertoires