DeleteLogByHandle-Funktion (clfsw32.h)

  • Artikel

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

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

Hinweis Diese Funktion unterscheidet sich von DeleteLogFile, da sie anstelle des Protokollnamens ein gültiges geöffnetes Handle für das Protokollobjekt verwendet.
 

Syntax

CLFSUSER_API BOOL DeleteLogByHandle(
  [in] HANDLE hLog
);

Parameter

[in] hLog

Ein Handle für ein geöffnetes Protokoll, das durch einen erfolgreichen Aufruf von CreateLogFile abgerufen wird. Das Protokoll muss mit DELETE-Zugriff erstellt worden sein, andernfalls können Sie das Protokoll nicht löschen.

Rückgabewert

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

Wenn die Funktion fehlschlägt, ist der Rückgabewert 0 (null). Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf. Die folgende Liste identifiziert die möglichen Fehlercodes:

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 R2 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile clfsw32.h
Bibliothek Clfsw32.lib
DLL Clfsw32.dll

Weitere Informationen

Allgemeine Protokolldateifunktionen

CreateLogFile

DeleteLogFile