Compartir a través de

Función ClearEventLogA (winbase.h)

  • Artículo

Borra el registro de eventos especificado y, opcionalmente, guarda la copia actual del registro en un archivo de copia de seguridad.

Sintaxis

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

Parámetros

[in] hEventLog

Identificador del registro de eventos que se va a borrar. La función openEventLog devuelve este identificador.

[in] lpBackupFileName

Ruta de acceso absoluta o relativa del archivo de copia de seguridad. Si este archivo ya existe, se produce un error en la función.

Si el parámetro lpBackupFileName es NULL, no se realiza una copia de seguridad del registro de eventos.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es distinto de cero.

Si se produce un error en la función, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError. La función ClearEventLog puede producir un error si el registro de eventos está vacío o el archivo de copia de seguridad ya existe.

Observaciones

Una vez que se devuelve esta función, no se pueden usar los identificadores que hagan referencia al registro de eventos borrados para leer el registro.

Nota

El encabezado winbase.h define ClearEventLog como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito Valor
cliente mínimo admitido Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de Windows
encabezado de winbase.h (incluya Windows.h)
biblioteca de Advapi32.lib
DLL de Advapi32.dll
conjunto de API de ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (introducido en Windows 10, versión 10.0.10240)

Consulte también

funciones de registro de eventos de

OpenEventLog