Función ReadLogArchiveMetadata (clfsw32.h)

Copia un intervalo de la vista de archivo de los metadatos en el búfer especificado.

Sintaxis

CLFSUSER_API BOOL ReadLogArchiveMetadata(
  [in]      CLFS_LOG_ARCHIVE_CONTEXT pvArchiveContext,
  [in]      ULONG                    cbOffset,
  [in]      ULONG                    cbBytesToRead,
  [in, out] PBYTE                    pbReadBuffer,
  [out]     PULONG                   pcbBytesRead
);

Parámetros

[in] pvArchiveContext

Puntero a un contexto de archivo que se obtiene mediante una llamada a PrepareLogArchive.

El contexto mantiene el estado del cursor, que permite la iteración a través del conjunto de extensiones de archivo del archivo. El cliente de archivo es responsable de desasignar el contexto mediante la función TerminateLogArchive .

[in] cbOffset

Desplazamiento en los metadatos donde se inicia la copia de datos.

En la primera llamada a esta función, especifique cero (0). En las llamadas posteriores, especifique el valor que se devuelve en pcbBytesRead.

[in] cbBytesToRead

El número de bytes de la instantánea de metadatos debe copiarse en pbReadBuffer.

Este parámetro no puede ser cero (0).

[in, out] pbReadBuffer

Puntero al búfer donde se copia la instantánea de metadatos.

[out] pcbBytesRead

Puntero a una variable que recibe el número de bytes que se copian en pbReadBuffer.

El número de bytes siempre está entre cero (0) y cbBytesToRead.

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 (0). Para obtener información de error extendida, llame a GetLastError. En la lista siguiente se identifican los posibles códigos de error:

Requisitos

Consulte también

Funciones comunes del sistema de archivos de registro

PrepareLogArchive

TerminateLogArchive