JetOSSnapshotGetFreezeInfo 関数

適用対象: Windows |Windows Server

JetOSSnapshotGetFreezeInfo 関数

JetOSSnapshotGetFreezeInfo 関数は、特定の時点でスナップショット セッションの一部であるインスタンスとデータベースの一覧を取得します。

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

    JET_ERR JET_API JetOSSnapshotGetFreezeInfo(
      __in          const JET_OSSNAPID snapId,
      __out         unsigned long* pcInstanceInfo,
      __out         JET_INSTANCE_INFO** paInstanceInfo,
      __in          const JET_GRBIT grbit
    );

パラメーター

snapId

開始するスナップショット セッションの識別子。

pcInstanceInfo

スナップショット セッションの一部である現在実行中のインスタンスの数。

paInstanceInfo

実行中のインスタンスごとに 1 つずつ、インスタンスとその一部であるデータベースを記述する構造体の配列。

grbit

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

戻り値

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

リターン コード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errOutOfMemory	メモリ不足の状態が原因で関数が失敗しました。
JET_errInvalidParameter	pcInstanceInfo または paInstanceInfo が NULL です。
JET_errOSSnapshotInvalidSnapId	スナップショット セッションの識別子が無効です。
JET_errOSSnapshotInvalidSequence	スナップショット セッションは進行中ではありません。

この関数が成功した場合、インスタンス情報は適切に入力され、返されたインスタンス情報配列へのポインターを使用して JetFreeBuffer を呼び出して、後で解放する必要があります。

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

要件

要件	値
Client	Windows Vista が必要です。
[サーバー]	Windows Server 2008 が必要です。
Header	Esent.h で宣言されています。
Library	ESENT.lib を使用します。
[DLL]	ESENT.dllが必要です。
Unicode	JetOSSnapshotGetFreezeInfoW (Unicode) および JetOSSnapshotGetFreezeInfoA (ANSI) として実装されます。

参照

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