DeleteFileA, fonction (fileapi.h)
Supprime un fichier existant.
Pour effectuer cette opération en tant qu’opération transactionnelle, utilisez la fonction DeleteFileTransacted.
Syntaxe
BOOL DeleteFileA(
[in] LPCSTR lpFileName
);
Paramètres
[in] lpFileName
Nom du fichier à supprimer.
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 des fichiers, des chemins d’accès et des espaces de noms.
Pourboire
À compter de Windows 10, version 1607, vous pouvez choisir de supprimer la limitation MAX_PATH sans précéder « \\ ?\ ». Pour plus d’informations, consultez la section « Limite maximale de longueur de chemin » de noms, fichiers, chemin s et espaces de noms.
Valeur de retour
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 (0). Pour obtenir des informations d’erreur étendues, appelez GetLastError.
Remarques
Si une application tente de supprimer un fichier qui n’existe pas, la fonction DeleteFile échoue avec ERROR_FILE_NOT_FOUND. Si le fichier est un fichier en lecture seule, la fonction échoue avec ERROR_ACCESS_DENIED.
La liste suivante identifie quelques conseils pour supprimer, supprimer ou fermer des fichiers :
- Pour supprimer un fichier en lecture seule, vous devez d’abord supprimer l’attribut en lecture seule.
- Pour supprimer ou renommer un fichier, vous devez disposer d’une autorisation de suppression sur le fichier ou supprimer l’autorisation enfant dans le répertoire parent.
- Pour supprimer de manière récursive les fichiers d’un répertoire, utilisez la fonction SHFileOperation.
- Pour supprimer un répertoire vide, utilisez la fonction RemoveDirectory.
- Pour fermer un fichier ouvert, utilisez la fonction CloseHandle.
Si vous configurez un répertoire avec tous les accès, sauf supprimer et supprimer un enfant, et que les listes de contrôle d’accès (ACL) des nouveaux fichiers sont héritées, vous pouvez créer un fichier sans pouvoir le supprimer. Toutefois, vous pouvez créer un fichier, puis obtenir tout l’accès que vous demandez sur le handle qui vous est retourné au moment de la création du fichier.
Si vous demandez l’autorisation de suppression au moment de la création d’un fichier, vous pouvez supprimer ou renommer le fichier avec ce handle, mais pas avec un autre handle. Pour plus d’informations, consultez Sécurité des fichiers et droits d’accès.
La fonction DeleteFile échoue si une application tente de supprimer un fichier qui a d’autres handles ouverts pour les E/S normales ou en tant que fichier mappé en mémoire (FILE_SHARE_DELETE doit avoir été spécifié lorsque d’autres handles ont été ouverts).
La fonction DeleteFile marque un fichier à supprimer à la fermeture. Par conséquent, la suppression du fichier ne se produit pas tant que le dernier handle du fichier n’est pas fermé. Les appels suivants à CreateFile pour ouvrir le fichier échouent avec ERROR_ACCESS_DENIED.
L’utilisation de la suppression POSIX entraîne la suppression du fichier pendant que les handles restent ouverts. Les appels suivants à CreateFile pour ouvrir le fichier échouent avec ERROR_FILE_NOT_FOUND.
Comportement de lien symbolique :
Si le chemin pointe vers un lien symbolique, le lien symbolique est supprimé, et non la cible. Pour supprimer une cible, vous devez appeler CreateFile et spécifier FILE_FLAG_DELETE_ON_CLOSE.
Dans Windows 8 et Windows Server 2012, cette fonction est prise en charge par les technologies suivantes :
| Technologie | Supporté |
|---|---|
| Protocole SMB (Server Message Block) 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 |
| Cluster Shared Volume File System (CsvFS) | Oui |
| Système de fichiers résilient (ReFS) | Oui |
Exemples
Pour obtenir un exemple, consultez verrouillage et déverrouillage des plages d’octets dans les fichiers.
Note
L’en-tête fileapi.h définit DeleteFile 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 XP [applications de bureau | Applications UWP] |
| serveur minimum pris en charge | Windows Server 2003 [applications de bureau | Applications UWP] |
| plateforme cible | Windows |
| d’en-tête | fileapi.h (include Windows.h) |
| bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |