JetEndExternalBackupInstance 函式

發行項
06/12/2023

適用于： Windows |Windows Server

JetEndExternalBackupInstance 函式

JetEndExternalBackupInstance函式會結束外部備份會話。此 API 是一系列 API 中的最後一個 API，必須呼叫才能在線上執行成功的線上 (非 VSS 型) 備份。

Windows XP：JetEndExternalBackupInstance 是在 Windows XP 中引進。

    JET_ERR JET_API JetEndExternalBackupInstance(
      __in          JET_INSTANCE instance
    );

參數

instance

要用於這個呼叫的實例。

Windows 2000： 對於 Windows 2000，無法使用接受此參數的 API 變體，因為只支援一個實例。在此情況下，會隱含使用此一個全域實例。

Windowsxp： 針對 Windows XP 和更新版本，只有在引擎處於舊版模式時，才能呼叫不接受此參數的 API 變體， (Windows 2000 相容性模式) 只支援一個實例。否則，作業將會因為JET_errRunningInMultiInstanceMode而失敗。

傳回值

此函式會傳回具有下列其中一個傳回碼的 JET_ERR 資料類型。如需可能 ESE 錯誤的詳細資訊，請參閱可延伸儲存引擎錯誤和錯誤處理參數。

傳回碼	Description
JET_errSuccess	作業已成功完成。
JET_errBackupAbortByCaller	Windowsxp：這個傳回值是在 Windows XP 中引進。呼叫端在備份順序中間終止備份，而不會向 JetStopBackup發出意圖的訊號。此錯誤是 Windows Server 2003 和更新版本中備份用戶端發生錯誤的結果。在 Windows XP 上，會針對外部備份順序的刻意終止傳回此錯誤。
JET_errBackupAbortByServer	Windows Server 2003：這個傳回值是在 Windows Server 2003 中引進。作業失敗，因為對 JetStopBackup的呼叫已中止目前的外部備份。
JET_errClientRequestToStopJetService	作業無法完成，因為與會話相關聯的實例上的所有活動都因為對 JetStopService的呼叫而停止。
JET_errInstanceUnavailable	Windowsxp：這個傳回值是在 Windows XP 中引進。作業無法完成，因為與會話相關聯的實例發生嚴重錯誤，需要撤銷所有資料的存取權，以保護該資料的完整性。
JET_errNoBackup	作業失敗，因為沒有任何外部備份正在進行中。
JET_errNotInitialized	作業無法完成，因為與會話相關聯的實例尚未初始化。
JET_errRestoreInProgress	作業無法完成，因為與會話相關聯的實例上正在進行還原作業。
JET_errRunningInMultiInstanceMode	作業失敗，因為嘗試在舊版模式中使用引擎， (Windows 2000 相容性模式) 其中只有一個實例已存在時，就已存在多個實例。
JET_errTermInProgress	作業無法完成，因為與會話相關聯的實例正在關閉。

如果函式成功，則外部備份成功。成功表示已從備份引擎擷取 JetBeginExternalBackup) 中所指定備份 (類型的所有檔案 (，例如資料庫和記錄) 。備份的檔案可以使用硬式復原來復原， (JetExternalRestore) 。

如果此函式失敗，外部備份通常會結束。失敗表示備份因為用戶端或應用程式使用錯誤而無效。請務必檢查此 API 的傳回碼，以確認備份順序是否成功。

備註

如果引擎設定為記錄事件，則會記錄事件以指出外部備份的解析。

如果備份順序未依序完成，且成功呼叫 JetEndExternalBackup，後續的增量備份可能包含比應用程式預期的更多資料。

如需外部備份 API 序列的詳細資訊，請參閱 JetBeginExternalBackup。

在 Windows Vista 之前，如果未完成記錄截斷，引擎會將備份視為複本備份。不過，備份可能是一般備份，例如，如果有中斷連結的資料庫) ，則不會 (截斷。 JET_bitBackupTruncateDone選項可用來通知引擎有關此情況，並允許修改適當的資料庫標頭。

規格需求

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

另請參閱

錯誤處理參數
 可延伸儲存引擎錯誤
 JetAttachDatabase
JetBeginExternalBackup
JetBeginExternalBackupInstance
JetCloseFile
JET_ERR
JetExternalRestore
JetGetAttachInfo
JetGetLogInfo
JET_INSTANCE
JetOpenFile
JetReadFile
JetStopBackup
JetStopService
JetTruncateLog

共用方式為

JetEndExternalBackupInstance 函式