JetStopBackupInstance 函数

适用于:Windows |Windows服务器

JetStopBackupInstance 函数

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

Windows XP:JetStopBackupInstance 在 Windows XP 中引入。

    JET_ERR JET_API JetStopBackupInstance(
      __in          JET_INSTANCE instance
    );

参数

实例

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

返回值

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

返回代码

说明

JET_errSuccess

操作已成功完成。

JET_errInvalidParameter

指定的实例参数具有无效值, (当前正在运行) 的实例。

Windows XP:Windows XP 中引入了此返回值。

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

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

注解

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

要求

要求

客户端

需要Windows Vista 或 Windows XP。

Server

需要Windows Server 2008 或 Windows Server 2003。

标头

在 Esent.h 中声明。

Library

使用 ESENT.lib。

DLL

需要ESENT.dll。

另请参阅

JET_ERR
JET_INSTANCE
JetEndExternalBackupInstance
JetReadFileInstance
JetStopService