Freigeben über


DeleteLogFile-Funktion (clfsw32.h)

Markiert ein Protokoll zum Löschen. Das Protokoll wird tatsächlich gelöscht, wenn alle Handles, Marshallingbereiche und Lesekontexte für das Protokoll geschlossen werden. Wenn es sich bei dem Protokoll um ein physisches Protokoll handelt, werden die zugrunde liegenden Container gelöscht.

Wenn ein Protokoll zum Löschen markiert ist, schlagen Anforderungen zum Öffnen neuer Clientprotokolldatenströme fehl.

Hinweis Eine eng verwandte Funktion ist DeleteLogByHandle-, die ein Protokoll löscht, wenn das Handle der Datei angegeben wird.

 

Syntax

CLFSUSER_API BOOL DeleteLogFile(
  [in]           LPCWSTR pszLogFileName,
  [in, optional] PVOID   pvReserved
);

Parameter

[in] pszLogFileName

Der Name des Protokolls.

Dieser Name wird beim Erstellen des Protokolls mithilfe CreateLogFile-angegeben. Im folgenden Beispiel wird das zu verwendende Format identifiziert:

Protokoll:<Protokollname>[::<Protokolldatenstromname>]

< Protokollname> einem gültigen Dateipfad im Dateisystem entspricht.

< Protokolldatenstromname> ist der eindeutige Name eines Protokolldatenstroms im Protokoll.

Weitere Informationen finden Sie unter Protokolltypen.

[in, optional] pvReserved

Dieser Parameter ist reserviert und sollte auf NULL-festgelegt werden.

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. Die folgende Liste identifiziert die möglichen Fehlercodes:

Anforderungen

Anforderung Wert
mindestens unterstützte Client- Windows Vista [nur Desktop-Apps]
mindestens unterstützte Server- Windows Server 2003 R2 [nur Desktop-Apps]
Zielplattform- Fenster
Header- clfsw32.h
Library Clfsw32.lib
DLL- Clfsw32.dll

Siehe auch

common Log File System Functions

CreateLogFile-

DeleteLogByHandle-

SECURITY_ATTRIBUTES