JetOSSnapshotTruncateLog 関数

適用対象: Windows |Windows Server

JetOSSnapshotTruncateLog 関数を使用すると、スナップショットセッションの一部であるすべてのインスタンスに対してログの切り捨てが可能になります。

Windows Vista:JetOSSnapshotTruncateLog は Windows Vista で導入されています。

    JET_ERR JET_API JetOSSnapshotTruncateLog(
      __in          const JET_OSSNAPID snapId,
      __in          const JET_GRBIT grbit
    );

snapId

スナップショットセッションの識別子。

grbit

この呼び出しのオプション。このパラメーターには、次の値の組み合わせを指定できます。

値	説明
JET_bitAllDatabasesSnapshot	ストレージエンジンがログの切り捨てを計算して実行できるように、すべてのデータベースがアタッチされます。
0 (ゼロ)	切り捨ては行われません。

この関数は、次のいずれかの戻りコードを使用して、JET_ERR データ型を返します。考えられる ESE エラーの詳細については、「拡張ストレージエンジンエラーとエラー処理パラメーター」を参照してください。

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errInvalidGrbit	grbit パラメーターが無効です。
JET_errOSSnapshotInvalidSequence	スナップショットセッションは、切り捨てが発生する可能性がある状態ではありません。次の原因が考えられます。呼び出しは、スナップショットセッションがタイムアウトした後に行われますセッションがコピースナップショットとして指定されました

リターンコード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errInvalidGrbit

grbit パラメーターが無効です。

JET_errOSSnapshotInvalidSequence

スナップショットセッションは、切り捨てが発生する可能性がある状態ではありません。次の原因が考えられます。

成功すると、スナップショットセッションの 1 つまたはすべてのインスタンス部分のログファイルは、可能であれば切り捨てられます。

この関数は、スナップショットが JET_bitContinueAfterThaw オプションで作成された場合にのみ呼び出す必要があります。それ以外の場合は、JetOSSnapshotThaw 呼び出しの後にスナップショットセッションが終了します。

フィードバック