Share via

Função ClearEventLogA (winbase.h)

  • Artigo

Limpa o log de eventos especificado e, opcionalmente, salva a cópia atual do log em um arquivo de backup.

Sintaxe

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

Parâmetros

[in] hEventLog

Um identificador para o log de eventos a ser limpo. A função OpenEventLog retorna esse identificador.

[in] lpBackupFileName

O caminho absoluto ou relativo do arquivo de backup. Se esse arquivo já existir, a função falhará.

Se o parâmetro lpBackupFileName for NULL, o log de eventos não será feito backup.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError. A função ClearEventLog poderá falhar se o log de eventos estiver vazio ou o arquivo de backup já existir.

Comentários

Depois que essa função retorna, todos os identificadores que fazem referência ao log de eventos desmarcados não podem ser usados para ler o log.

Observação

O cabeçalho winbase.h define ClearEventLog como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho winbase.h (inclua Windows.h)
Biblioteca Advapi32.lib
DLL Advapi32.dll
Conjunto de APIs ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (introduzido no Windows 10, versão 10.0.10240)

Confira também

Funções de log de eventos

OpenEventLog