適用于： Windows |Windows Server
JetGetTruncateLogInfoInstance 函式
JetGetTruncateLogInfoInstance函式會在JetBeginExternalBackup所起始的備份期間使用，以查詢實例中可安全地刪除備份之後可安全地刪除的交易記錄檔名稱。
Windows XP：JetGetTruncateLogInfoInstance 是在 Windows XP 中引進的。
JET_ERR JET_API JetGetTruncateLogInfoInstance(
__in JET_INSTANCE instance,
__out_opt tchar* szz,
__in unsigned long cbMax,
__out_opt unsigned long* pcbActual
);
參數
instance
要用於這個呼叫的 實例。
szz
輸出緩衝區，接收以 Null 終止的字串清單，描述備份成功完成之後可安全地刪除的交易記錄檔集。
此緩衝區中傳回的字串清單的格式與登錄所使用的多字串格式相同。 每個以 Null 終止的字串會依序傳回，後面接著最後的 Null 結束字元。
cbMax
輸出緩衝區的位元組大小上限。
azureActual
接收實際字串資料的輸出緩衝區指標。
傳回值
此函式會傳回具有下列其中一個傳回碼 的JET_ERR 資料類型。 如需可能 ESE 錯誤的詳細資訊，請參閱 可延伸的儲存引擎錯誤 和 錯誤處理參數。
傳回碼 |
描述 |
|---|---|
JET_errSuccess |
作業已成功完成。 |
JET_errInvalidParameter |
其中一個提供的參數包含非預期的值，或數個參數值的組合會導致非預期的結果。 Windows XP 和更新版本： 當指定的實例控制碼無效時， JetGetTruncateLogInfoInstance 可能會發生這種情況。 |
JET_errNotInitialized |
作業無法完成，因為與會話相關聯的實例尚未初始化。 |
JET_errClientRequestToStopJetService |
作業無法完成，因為與會話相關聯的實例上的所有活動都因為對 JetStopService的呼叫而停止。 |
JET_errInstanceUnavailable |
作業無法完成，因為與會話相關聯的實例發生嚴重錯誤，需要撤銷所有資料的存取權，以保護該資料的完整性。 Windowsxp： 此傳回值是在 Windows XP 中引進的。 |
JET_errBackupAbortByServer |
作業失敗，因為對 JetStopBackup的呼叫已中止目前的外部備份。 Windowsxp： 此傳回值是在 Windows XP 中引進的。 |
JET_errInvalidBackupSequence |
備份作業失敗，因為它已依序呼叫。 |
JET_errNoBackup |
作業失敗，因為沒有任何外部備份正在進行中。 |
JET_errRestoreInProgress |
作業無法完成，因為與會話相關聯的實例上正在進行還原作業。 |
JET_errTermInProgress |
作業無法完成，因為與會話相關聯的實例正在關閉。 |
JetGetTruncateLogInfoInstance |
實例使用 JetOpenFile 建立的未完成檔案控制碼。 |
如果此函式成功，在備份成功完成之後，可安全地刪除之交易記錄檔集的要求資訊，將會放在提供的輸出緩衝區中。 備份狀態機器將會進階，因此不再允許備份資料庫檔案。 只有資料庫修補檔和交易記錄檔可以開啟，以便備份超過此點。
如果此函式失敗，輸出緩衝區的狀態為未定義。 失敗會導致實例的整個備份程式取消。
備註
如果輸出緩衝區太小而無法接受應該屬於備份檔案集一部分的完整檔案清單，此 API 不會傳回錯誤或警告。 應用程式應該一律提供緩衝區來接收此清單的實際大小，並使用該資訊來判斷清單是否已截斷。
規格需求
| 需求 | 值 |
|---|---|
用戶端 |
需要 Windows Vista 或 Windows XP。 |
Server |
需要 Windows Server 2008 或 Windows Server 2003。 |
標頭 |
在 Esent.h 中宣告。 |
程式庫 |
使用 ESENT.lib。 |
Dll |
需要ESENT.dll。 |
Unicode |
實作為 JetGetTruncateLogInfoInstanceW (Unicode) 和 JetGetTruncateLogInfoInstanceA (ANSI) 。 |
另請參閱
JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetCloseDatabase
JetCloseTable
JetEndSession
JetOpenFile
JetResetSessionCoNtext
JetRollback
JetStopBackup
JetStopService
JetTerm
JetTerm2