JetOSSnapshotPrepareInstance 函式

發行項
06/12/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 錯誤的詳細資訊，請參閱可延伸的儲存引擎錯誤和錯誤處理參數。

傳回碼	Description
JET_errSuccess	作業已成功完成。
JET_errInvalidParameter	快照集識別碼指標為 Null 或 grbit 參數無效。
JET_errOSSnapshotInvalidSequence	快照集會話正在進行中。
JET_errOSSnapshotInvalidSnapId	快照集會話的識別碼無效。

如果此函式成功，指定的實例將會是快照集會話的一部分。

如果此函式失敗，則不會變更引擎狀態。

備註

一般 API 順序呼叫為： JetOSSnapshotPrepare，選擇性地接著一或多個 JetOSSnapshotPrepareInstance的呼叫，然後接著 JetOSSnapshotFreeze。凍結啟動之後，可以使用 JetOSSnapshotThaw終止。在準備之後，快照集會話可以隨時使用 JetOSSnapshotAbort突然終止。系統會針對快照集的不同步驟產生事件記錄檔專案。

如果 JetOSSnapshotPrepareInstance 在會話開頭 (JetOSSnapshotPrepare) 和凍結時間 (JetOSSnapshotFreeze) ，引擎中的所有執行中實例都會凍結並成為快照集會話的一部分。這會發生兩個原因：

它可簡化想要所有實例的使用者程式碼。
它允許快照集 API 呼叫端的回溯相容性。

規格需求

需求	值
用戶端	需要 Windows Vista。
Server	需要 Windows Server 2008。
標頭	在 Esent.h 中宣告。
程式庫	使用 ESENT.lib。
Dll	需要ESENT.dll。

另請參閱

錯誤處理參數
 可延伸儲存引擎錯誤
 JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw

共用方式為

JetOSSnapshotPrepareInstance 函式