DeleteFile, fonction (winbase.h)
Supprime un fichier existant.
Pour effectuer cette opération en tant qu’opération transactionnelle, utilisez la fonction DeleteFileTransacted .
Syntaxe
BOOL DeleteFile(
[in] LPCTSTR 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 de large, 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 de MAX_PATH sans précédencer « \ ?\ ». Pour plus d’informations, consultez la section « Limitation de longueur maximale du chemin d’accès » dans 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 (0). Pour obtenir des informations détaillées sur l’erreur, 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 répertorie 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 de l’autorisation supprimer 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 demandez l’autorisation de suppression au moment où vous créez 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 descripteurs ouverts pour les E/S normales ou en tant que fichier mappé en mémoire (FILE_SHARE_DELETE doit avoir été spécifié lors de l’ouverture d’autres handles).
La fonction DeleteFile marque un fichier à supprimer à la fermeture. Par conséquent, la suppression du fichier n’a pas lieu tant que le dernier handle du fichier n’est pas fermé. Les appels suivants à CreateFile pour ouvrir le fichier échouent avec ERROR_ACCESS_DENIED.
Comportement des liens symboliques :
Si le chemin pointe vers un lien symbolique, ce lien symbolique est supprimé, mais pas 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 | 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 |
Exemples
Pour obtenir un exemple, consultez Verrouillage et déverrouillage de plages d’octets dans des fichiers.
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 | winbase.h (inclure Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |