Função ClearEventLogA (winbase.h)
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 de retorno
Se a função for bem-sucedida, o valor retornado não será 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.
Observações
Depois que essa função é retornada, os identificadores que fazem referência ao log de eventos desmarcados não podem ser usados para ler o log.
Nota
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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| servidor com suporte mínimo | Windows 2000 Server [somente aplicativos da área de trabalho] |
| da Plataforma de Destino |
Windows |
| cabeçalho | winbase.h (inclua Windows.h) |
| biblioteca | Advapi32.lib |
| de DLL |
Advapi32.dll |
| conjunto de API | ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (introduzido no Windows 10, versão 10.0.10240) |