ClearEventLogA, fonction (winbase.h)

Article
08/27/2023

Efface le journal des événements spécifié et enregistre éventuellement la copie actuelle du journal dans un fichier de sauvegarde.

Syntaxe

BOOL ClearEventLogA(
  [in] HANDLE hEventLog,
  [in] LPCSTR lpBackupFileName
);

Paramètres

[in] hEventLog

Handle du journal des événements à effacer. La fonction OpenEventLog retourne ce handle.

[in] lpBackupFileName

Chemin absolu ou relatif du fichier de sauvegarde. Si ce fichier existe déjà, la fonction échoue.

Si le paramètre lpBackupFileName a la valeur NULL, le journal des événements n’est pas sauvegardé.

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. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. La fonction ClearEventLog peut échouer si le journal des événements est vide ou si le fichier de sauvegarde existe déjà.

Remarques

Une fois cette fonction retournée, les handles qui font référence au journal des événements effacé ne peuvent pas être utilisés pour lire le journal.

Notes

L’en-tête winbase.h définit ClearEventLog comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winbase.h (inclure Windows.h)
Bibliothèque	Advapi32.lib
DLL	Advapi32.dll
Ensemble d’API	ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (introduit dans Windows 10, version 10.0.10240)

Voir aussi

Fonctions de journalisation des événements

OpenEventLog

Partager via