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
結構的陣列,每個執行中的實例各一個,描述實例及其所屬的資料庫。
grbit
這個呼叫的選項。 這個參數保留給未來使用。 唯一的有效值為 0 (零) 。
傳回值
此函式會傳回具有下列其中一個傳回碼 的 JET_ERR 資料類型。 如需可能 ESE 錯誤的詳細資訊,請參閱 可延伸儲存引擎錯誤 和 錯誤處理參數。
傳回碼 |
Description |
---|---|
JET_errSuccess |
作業已成功完成。 |
JET_errOutOfMemory |
函式因記憶體不足狀況而失敗。 |
JET_errInvalidParameter |
pcInstanceInfo 或 paInstanceInfo 為 Null。 |
JET_errOSSnapshotInvalidSnapId |
快照集會話的識別碼無效。 |
JET_errOSSnapshotInvalidSequence |
快照集會話未進行中。 |
如果此函式成功,則會正確填入實例資訊,而且稍後必須呼叫 JetFreeBuffer ,並具有傳回之實例資訊陣列的指標來釋放它。
如果此函式失敗,則不會變更引擎狀態。
規格需求
需求 | 值 |
---|---|
用戶端 |
需要 Windows Vista。 |
Server |
需要 Windows Server 2008。 |
標頭 |
在 Esent.h 中宣告。 |
程式庫 |
使用 ESENT.lib。 |
Dll |
需要ESENT.dll。 |
Unicode |
實作為 JetOSSnapshotGetFreezeInfoW (Unicode) 和 JetOSSnapshotGetFreezeInfoA (ANSI) 。 |
另請參閱
錯誤處理參數
可延伸儲存引擎錯誤
JET_ERR
JetFreeBuffer
JetOSSnapshotAbort
JetOSSnapshotFreeze
JetOSSnapshotThaw