JetOSSnapshotPrepareInstance 函数

适用于： 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 错误的详细信息，请参阅 可扩展存储引擎错误 和 错误处理参数。

返回代码	说明
JET_errSuccess	操作已成功完成。
JET_errInvalidParameter	快照 ID 指针为 NULL 或 grbit 参数无效。
JET_errOSSnapshotInvalidSequence	快照会话已在进行中。
JET_errOSSnapshotInvalidSnapId	快照会话的标识符无效。

如果此函数成功，则指定的实例将成为快照会话的一部分。

如果此函数失败，则不会更改引擎状态。

备注

正常的 API 序列调用为： JetOSSnapshotPrepare，后跟对 JetOSSnapshotPrepareInstance 的一个或多个调用，然后是 JetOSSnapshotFreeze。 冻结开始后，可以使用 JetOSSnapshotThaw 终止冻结。 准备后，随时可以使用 JetOSSnapshotAbort 突然终止快照会话。 将为快照的不同步骤生成事件日志条目。

如果在会话开始 (JetOSSnapshotPrepare) 与 JetOSSnapshotFreeze) 冻结时刻 (之间未调用 JetOSSnapshotPrepareInstance，则引擎中的所有正在运行的实例都将冻结并成为快照会话的一部分。 发生这种情况有两个原因：

• 它简化了需要所有实例的用户的代码。

• 它允许快照 API 的调用方向后兼容。

要求

要求	值
客户端	需要 Windows Vista。
服务器	需要 Windows Server 2008。
标头	在 Esent.h 中声明。
Library	使用 ESENT.lib。
DLL	需要ESENT.dll。

另请参阅

错误处理参数
可扩展存储引擎错误
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw