JetOSSnapshotPrepareInstance 関数

[アーティクル]
06/13/2023

適用対象: Windows |Windows Server

JetOSSnapshotPrepareInstance 関数

JetOSSnapshotPrepareInstance 関数は、スナップショットセッションの一部となる特定のインスタンスを選択します。

Windows Vista:JetOSSnapshotPrepareInstance が Windows Vista で導入されました。

JET_ERR JET_API JetOSSnapshotPrepareInstance(
  __in          JET_OSSNAPID snapId,
  __in          JET_INSTANCE instance,
  __in          const JET_GRBIT grbit
);

パラメーター

snapId

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

instance

この呼び出しに使用されるインスタンス。

grbit

この呼び出しのオプション。このパラメーターは将来使用するために予約されています。有効な値は 0 (ゼロ) のみです。

戻り値

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

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errInvalidParameter	スナップショット id ポインターが NULL であるか、grbit パラメーターが無効です。
JET_errOSSnapshotInvalidSequence	スナップショットセッションは既に進行中です。
JET_errOSSnapshotInvalidSnapId	スナップショットセッションの識別子が無効です。

この関数が成功した場合、指定されたインスタンスはスナップショットセッションの一部になります。

この関数が失敗した場合、エンジンの状態は変更されません。

解説

通常の API シーケンス呼び出しは、 JetOSSnapshotPrepare で、必要に応じて JetOSSnapshotPrepareInstance への 1 つ以上の呼び出しが続き、その後に JetOSSnapshotFreeze が続きます。フリーズが開始されると、 JetOSSnapshotThaw を使用して終了できます。準備後はいつでも、JetOSSnapshotAbort でスナップショットセッションを突然終了できます。イベントログエントリは、スナップショットのさまざまな手順に対して生成されます。

JetOSSnapshotPrepareInstance がセッションの開始 (JetOSSnapshotPrepare) とフリーズモーメント (JetOSSnapshotFreeze) の間に呼び出されない場合、エンジン内のすべての実行中のインスタンスがフリーズし、スナップショットセッションの一部になります。これは、次の 2 つの理由で発生します。

これにより、すべてのインスタンスを必要とするユーザーのコードが簡略化されます。
これにより、スナップショット API の呼び出し元の下位互換性が可能になります。

必要条件

要件	値
Client	Windows Vista が必要です。
[サーバー]	Windows Server 2008 が必要です。
Header	Esent.h で宣言されています。
Library	ESENT.lib を使用します。
[DLL]	ESENT.dllが必要です。

参照

エラー処理パラメーター
 記憶域エンジンの拡張可能なエラー
 JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw

次の方法で共有

JetOSSnapshotPrepareInstance 関数