JetStopBackupInstance 函数

适用于： Windows |Windows Server

JetStopBackupInstance 函数

JetStopBackupInstance 函数阻止流式处理备份相关活动在特定正在运行的实例上继续，从而以可预测的方式结束流式备份。

Windows XP：JetStopBackupInstance 是在 Windows XP 中引入的。

    JET_ERR JET_API JetStopBackupInstance(
      __in          JET_INSTANCE instance
    );

parameters

instance

标识要用于 API 调用的正在运行的实例。

返回值

此函数返回具有以下返回代码之一 的JET_ERR 数据类型。 有关可能的 ESE 错误的详细信息，请参阅 可扩展存储引擎错误 和 错误处理参数。

返回代码	说明
JET_errSuccess	操作已成功完成。
JET_errInvalidParameter	指定的实例参数具有无效值， (不是当前运行) 的实例。 Windowsxp： 此返回值在 Windows XP 中引入。

如果此函数成功，则指定的实例将开始使任何新的流式备份 API 失败。

如果此函数失败，则不会执行任何步骤来准备实例上的备份终止，并且不会更改实例状态。

备注

备份通常由进程机制外部的事件触发，并且使用此 API，ESENT 应用程序本身将进一步调用流式备份 API 失败。 大多数流式备份 API 将开始失败，JET_errBackupAbortByServer。 因此，任何流式备份进度 (（如 JetReadFileInstance) ）都将返回错误。 仍允许备份终止 (（如 JetEndExternalBackupInstance) ）的备份操作。

要求

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

另请参阅

JET_ERR
JET_INSTANCE
JetEndExternalBackupInstance
JetReadFileInstance
JetStopService