GetNextLogArchiveExtent 関数 (clfsw32.h)
ログ アーカイブ コンテキスト内のアーカイブ エクステントの次のセットを取得します。 ログ アーカイブ コンテキストは、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 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 次の一覧は、考えられるエラー コードを示しています。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 R2 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | clfsw32.h |
| Library | Clfsw32.lib |
| [DLL] | Clfsw32.dll |