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

CreateLogContainerScanContext 関数が初期化するクライアント割り当てCLFS_SCAN_CONTEXT構造体へのポインター。

[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 に設定します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

次の一覧は、考えられるエラーコードを示しています。

注釈

ログコンテナーの ID は、pcxScan-pinfoContainer-LogicalContainerId>> で返されます。

メモ共通ログファイルシステム (CLFS) スキャンコンテキストはスレッドセーフではありません。一度に複数のスレッドで使用したり、一度に複数の非同期スキャンに渡したりしないでください。

例

この関数を使用する例については、「ログコンテナーの列挙」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 R2 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	clfsw32.h
Library	Clfsw32.lib
[DLL]	Clfsw32.dll