大网数据广告活动
磁盘与文件系统

JetStopBackupInstance Function

· 52CE 我爱测

Learn more about: JetStopBackupInstance Function

Applies to: Windows | Windows Server

JetStopBackupInstance Function

The JetStopBackupInstance function prevents streaming backup-related activity from continuing on a specific running instance, thus ending the streaming backup in a predictable way.

Windows XP:  JetStopBackupInstance is introduced in Windows XP.

    JET_ERR JET_API JetStopBackupInstance(
      __in          JET_INSTANCE instance
    );

Parameters

instance

Identifies the running instance to use for the API call.

Return Value

This function returns the JET_ERR datatype with one of the following return codes. For more information about the possible ESE errors, see Extensible Storage Engine Errors and Error Handling Parameters.

Return code Description
JET_errSuccess The operation completed successfully.
JET_errInvalidParameter The specified instance parameter has an invalid value (not an instance that is currently running).Windows XP:  This return value is introduced in Windows XP.

If this function succeeds, the instance that was specified will start failing any new streaming backup APIs.

If this function fails, no steps to prepare for the backup termination on the instance will be taken and no change to the instance state will occur.

Remarks

Backup is usually triggered by an event outside the process mechanism and by using this API, the ESENT application itself will make any further calls to the streaming backup APIs to fail. The majority of streaming backup APIs will start failing with JET_errBackupAbortByServer. As such, any streaming backup progress (such as JetReadFileInstance) will return an error. Backup operations which are part of the backup termination (like JetEndExternalBackupInstance) will still be allowed.

Requirements
Requirement Value
Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008 or Windows Server 2003.
Header Declared in Esent.h.
Library Use ESENT.lib.
DLL Requires ESENT.dll.
See Also

JET_ERR
JET_INSTANCE
JetEndExternalBackupInstance
JetReadFileInstance
JetStopService

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 04/11/2016
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。