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

Статья
08/22/2023

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

Синтаксис

CLFSUSER_API BOOL GetNextLogArchiveExtent(
  [in]      CLFS_LOG_ARCHIVE_CONTEXT   pvArchiveContext,
  [in, out] CLFS_ARCHIVE_DESCRIPTOR [] rgadExtent,
  [in]      ULONG                      cDescriptors,
  [out]     PULONG                     pcDescriptorsReturned
);

Параметры

[in] pvArchiveContext

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

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

[in, out] rgadExtent

Выделенный клиентом массив CLFS_ARCHIVE_DESCRIPTOR структур, заполняемых этой функцией.

[in] cDescriptors

Количество элементов в массиве rgadExtent .

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

[out] pcDescriptorsReturned

Количество дескрипторов в массиве rgadExtent , заполненных этой функцией.

Если это значение меньше cDescriptors, набор дескрипторов исчерпан, и клиент архива может завершить итерацию с помощью упорядоченного набора дескрипторов. Дальнейшие вызовы этой функции завершаются сбоем с ERROR_NO_MORE_ENTRIES.

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

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

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

Требования

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

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

CLFS_ARCHIVE_DESCRIPTOR

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