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

Статья
08/22/2023

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

Синтаксис

CLFSUSER_API BOOL ScanLogContainers(
  [in, out]           PCLFS_SCAN_CONTEXT pcxScan,
  [in]                CLFS_SCAN_MODE     eScanMode,
  [in, out, optional] LPVOID             pReserved
);

Параметры

[in, out] pcxScan

Указатель на структуру, выделенную клиентом CLFS_SCAN_CONTEXT , которую инициализирует функция CreateLogContainerScanContext .

[in] eScanMode

Режим проверки контейнеров.

Контейнеры можно сканировать в любом из следующих режимов CLFS_SCAN_MODE .

Значение	Значение
CLFS_SCAN_INIT	Повторно инициализирует контекст сканирования, но не выделяет связанное хранилище. Инициализация является разрушительной, так как все данные, хранящиеся в текущем контексте сканирования, теряются.
CLFS_SCAN_CLOSE	Неинициализирует контекст сканирования и освобождает системное хранилище, связанное с контекстом сканирования.
CLFS_SCAN_FORWARD	Приводит к тому, что следующий вызов ScanLogContainers будет продолжаться в направлении вперед. Не может использоваться, если указан CLFS_SCAN_BACKWARD .
CLFS_SCAN_BACKWARD	Вызывает следующий вызов ScanLogContainers в обратном направлении. Не может использоваться, если указан CLFS_SCAN_FORWARD .

[in, out, optional] pReserved

Зарезервировано. Задайте для параметра pReserved значение NULL.

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

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

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

В следующем списке указаны возможные коды ошибок:

Примечание Контексты проверки common Log File System (CLFS) не являются потокобезопасны. Они не должны использоваться несколькими потоками одновременно или передаваться в несколько асинхронных проверок одновременно.

Примеры

Пример использования этой функции см. в разделе Перечисление контейнеров журналов.

Требования

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