Функция ReadLogArchiveMetadata (clfsw32.h)

Статья
08/22/2023

Копирует диапазон архивного представления метаданных в указанный буфер.

Синтаксис

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

Параметры

[in] pvArchiveContext

Указатель на контекст архива, полученный при вызове PrepareLogArchive.

Контекст поддерживает состояние курсора, что позволяет выполнять итерацию по набору экстентов файла в архиве. Клиент архива отвечает за освобождение контекста с помощью функции TerminateLogArchive .

[in] cbOffset

Смещение в метаданных, где начинается копирование данных.

При первом вызове этой функции укажите ноль (0). При последующих вызовах укажите значение, возвращаемое в pcbBytesRead.

[in] cbBytesToRead

Количество байтов метаданных, snapshot должны быть скопированы в pbReadBuffer.

Этот параметр не может быть равен нулю (0).

[in, out] pbReadBuffer

Указатель на буфер, в который копируются snapshot метаданных.

[out] pcbBytesRead

Указатель на переменную, получающую количество байтов, копируемых в pbReadBuffer.

Число байтов всегда находится в диапазоне от нуля (0) до cbBytesToRead.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция завершается ошибкой, возвращаемое значение равно нулю (0). Дополнительные сведения об ошибке можно получить, вызвав GetLastError. В следующем списке указаны возможные коды ошибок:

Требования


Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 R2 [только классические приложения]
Целевая платформа	Windows
Header	clfsw32.h
Библиотека	Clfsw32.lib
DLL	Clfsw32.dll

См. также раздел

Общие функции файловой системы журнала

PrepareLogArchive

TerminateLogArchive