Función ReadEventLogA (winbase.h)

Artículo
03/13/2024

Lee el número especificado de entradas del registro de eventos especificado. La función se puede usar para leer entradas de registro en orden cronológico o cronológico inverso.

Sintaxis

BOOL ReadEventLogA(
  [in]  HANDLE hEventLog,
  [in]  DWORD  dwReadFlags,
  [in]  DWORD  dwRecordOffset,
  [out] LPVOID lpBuffer,
  [in]  DWORD  nNumberOfBytesToRead,
  [out] DWORD  *pnBytesRead,
  [out] DWORD  *pnMinNumberOfBytesNeeded
);

Parámetros

[in] hEventLog

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

[in] dwReadFlags

Use los siguientes valores de marca para indicar cómo leer el archivo de registro. Este parámetro debe incluir uno de los valores siguientes (las marcas son mutuamente excluyentes).

Valor	Significado
EVENTLOG_SEEK_READ 0x0002	Comience a leer desde el registro especificado en el parámetro dwRecordOffset . Esta opción puede no funcionar con archivos de registro grandes si la función no puede determinar el tamaño del archivo de registro. Para obtener más información, consulte el artículo de Knowledge Base, 177199.
EVENTLOG_SEQUENTIAL_READ 0x0001	Lea los registros secuencialmente. Si se trata de la primera operación de lectura, las marcas de EVENTLOG_FORWARDS_READ EVENTLOG_BACKWARDS_READ determinan qué registro se lee primero.

Debe especificar una de las marcas siguientes para indicar la dirección de las operaciones de lectura sucesivas (las marcas son mutuamente excluyentes).

Valor	Significado
EVENTLOG_FORWARDS_READ 0x0004	El registro se lee en orden cronológico (más antiguo a más reciente). El valor predeterminado.
EVENTLOG_BACKWARDS_READ 0x0008	El registro se lee en orden cronológico inverso (más reciente a más antiguo).

[in] dwRecordOffset

Número de registro de la entrada de registro en la que se debe iniciar la operación de lectura. Este parámetro se omite a menos que dwReadFlags incluya la marca EVENTLOG_SEEK_READ .

[out] lpBuffer

Búfer asignado a la aplicación que recibirá una o varias estructuras EVENTLOGRECORD . Este parámetro no puede ser NULL, aunque el parámetro nNumberOfBytesToRead sea cero.

El tamaño máximo de este búfer es 0x7ffff bytes.

[in] nNumberOfBytesToRead

Tamaño del búfer lpBuffer , en bytes. Esta función leerá tantas entradas de registro como caben en el búfer; la función no devolverá entradas parciales.

[out] pnBytesRead

Puntero a una variable que recibe el número de bytes leídos por la función.

[out] pnMinNumberOfBytesNeeded

Puntero a una variable que recibe el tamaño necesario del búfer lpBuffer . Este valor solo es válido si esta función devuelve cero y GetLastError devuelve ERROR_INSUFFICIENT_BUFFER.

Valor devuelto

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

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Cuando esta función se devuelve correctamente, el número de registros leídos ajusta la posición de lectura en el registro de eventos.

Nota El nombre de archivo configurado para este origen también puede ser el nombre de archivo configurado para otros orígenes (varios orígenes pueden existir como subclaves en un único registro). Por lo tanto, esta función puede devolver eventos registrados por más de un origen.

Ejemplos

Para obtener un ejemplo, vea Consulta de información de eventos.

Nota

El encabezado winbase.h define ReadEventLog 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 Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winbase.h (incluye Windows.h)
Library	Advapi32.lib
Archivo DLL	Advapi32.dll
Conjunto de API	ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (introducido en Windows 10, versión 10.0.10240)