DeleteFileA-Funktion (fileapi.h)

Artikel
11/20/2024

Löscht eine vorhandene Datei.

Verwenden Sie die DeleteFileTransacted-Funktion, um diesen Vorgang als transacted-Vorgang auszuführen.

Syntax

BOOL DeleteFileA(
  [in] LPCSTR lpFileName
);

Parameter

[in] lpFileName

Der Name der zu löschenden Datei.

Standardmäßig ist der Name auf MAX_PATH Zeichen beschränkt. Um diesen Grenzwert auf 32.767 breite Zeichen zu erweitern, stellen Sie "\\?\" dem Pfad voran. Weitere Informationen finden Sie unter Namensdateien, Pfade und Namespaces.

Trinkgeld

Ab Windows 10, Version 1607, können Sie sich anmelden, um die MAX_PATH Einschränkung zu entfernen, ohne "\\?\". Weitere Informationen finden Sie im Abschnitt "Maximale Pfadlängenbeschränkung" Benennungsdateien, Pfade und Namespaces.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null (0). Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Wenn eine Anwendung versucht, eine datei zu löschen, die nicht vorhanden ist, schlägt die DeleteFile--Funktion mit ERROR_FILE_NOT_FOUNDfehl. Wenn es sich bei der Datei um eine schreibgeschützte Datei handelt, schlägt die Funktion mit ERROR_ACCESS_DENIEDfehl.

In der folgenden Liste werden einige Tipps zum Löschen, Entfernen oder Schließen von Dateien aufgeführt:

Um eine schreibgeschützte Datei zu löschen, müssen Sie zuerst das schreibgeschützte Attribut entfernen.
Um eine Datei zu löschen oder umzubenennen, müssen Sie entweder über die Berechtigung zum Löschen der Datei oder über die Berechtigung zum Löschen untergeordneter Elemente im übergeordneten Verzeichnis verfügen.
Um die Dateien in einem Verzeichnis rekursiv zu löschen, verwenden Sie die funktion SHFileOperation.
Verwenden Sie zum Entfernen eines leeren Verzeichnisses die funktion RemoveDirectory.
Verwenden Sie zum Schließen einer geöffneten Datei die CloseHandle--Funktion.

Wenn Sie ein Verzeichnis mit allen Zugriffen einrichten, mit Ausnahme des Löschens und Löschens untergeordneter Elemente, und die Zugriffssteuerungslisten (Access Control Lists, ACL) neuer Dateien geerbt werden, können Sie eine Datei erstellen, ohne sie löschen zu können. Anschließend können Sie jedoch eine Datei erstellen und dann den gesamten Zugriff erhalten, den Sie für das Handle anfordern, das sie zum Zeitpunkt der Erstellung der Datei an Sie zurückgibt.

Wenn Sie zum Zeitpunkt der Erstellung einer Datei die Löschberechtigung anfordern, können Sie die Datei mit diesem Handle löschen oder umbenennen, jedoch nicht mit einem anderen Handle. Weitere Informationen finden Sie unter Dateisicherheits- und Zugriffsberechtigungen.

Die DeleteFile--Funktion schlägt fehl, wenn eine Anwendung versucht, eine Datei zu löschen, die andere Handles für normale E/A oder als speicherzuordnunge Datei geöffnet hat (FILE_SHARE_DELETE müssen angegeben werden, wenn andere Handles geöffnet wurden).

Die DeleteFile--Funktion kennzeichnet eine Datei zum Löschen beim Schließen. Daher tritt das Löschen der Datei erst auf, wenn das letzte Handle für die Datei geschlossen wird. Nachfolgende Aufrufe von CreateFile- zum Öffnen der Datei schlagen mit ERROR_ACCESS_DENIEDfehl.

Die Verwendung des POSIX-Löschvorgangs bewirkt, dass die Datei gelöscht wird, während Handles geöffnet bleiben. Nachfolgende Aufrufe von CreateFile- zum Öffnen der Datei schlagen mit ERROR_FILE_NOT_FOUNDfehl.

Verhalten symbolischer Verknüpfungen:

Wenn der Pfad auf eine symbolische Verknüpfung zeigt, wird die symbolische Verknüpfung gelöscht, nicht das Ziel. Zum Löschen eines Ziels müssen Sie CreateFile- aufrufen und FILE_FLAG_DELETE_ON_CLOSEangeben.

In Windows 8 und Windows Server 2012 wird diese Funktion von den folgenden Technologien unterstützt:

Technologie	Abgestützt
Server Message Block (SMB) 3.0-Protokoll	Ja
SMB 3.0 Transparent Failover (TFO)	Ja
SMB 3.0 mit Skalierungsdateifreigaben (SO)	Ja
Freigegebenes Clustervolumedateisystem (CsvFS)	Ja
Resilient File System (ReFS)	Ja

Beispiele

Ein Beispiel finden Sie unter Sperren und Entsperren von Bytebereichen in Dateien.

Anmerkung

Der Fileapi.h-Header definiert DeleteFile- als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows XP [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	fileapi.h (include Windows.h)
Library	Kernel32.lib
DLL-	Kernel32.dll