ClearEventLogA-Funktion (winbase.h)
Löscht das angegebene Ereignisprotokoll und speichert optional die aktuelle Kopie des Protokolls in einer Sicherungsdatei.
Syntax
BOOL ClearEventLogA(
[in] HANDLE hEventLog,
[in] LPCSTR lpBackupFileName
);
Parameter
[in] hEventLog
Ein Handle für das Ereignisprotokoll, das gelöscht werden soll. Die OpenEventLog--Funktion gibt dieses Handle zurück.
[in] lpBackupFileName
Der absolute oder relative Pfad der Sicherungsdatei. Wenn diese Datei bereits vorhanden ist, schlägt die Funktion fehl.
Wenn der lpBackupFileName Parameter NULL-ist, wird das Ereignisprotokoll nicht gesichert.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten. Die ClearEventLog--Funktion kann fehlschlagen, wenn das Ereignisprotokoll leer ist oder die Sicherungsdatei bereits vorhanden ist.
Bemerkungen
Nachdem diese Funktion zurückgegeben wurde, können alle Handles, die auf das gelöschte Ereignisprotokoll verweisen, nicht zum Lesen des Protokolls verwendet werden.
Anmerkung
Der winbase.h-Header definiert ClearEventLog 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 2000 Professional [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | winbase.h (enthalten Windows.h) |
| Library | Advapi32.lib |
| DLL- | Advapi32.dll |
| API-Satz | ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (eingeführt in Windows 10, Version 10.0.10240) |