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

JetOSSnapshotGetFreezeInfo Function

· 52CE 我爱测

Learn more about: JetOSSnapshotGetFreezeInfo Function

Applies to: Windows | Windows Server

JetOSSnapshotGetFreezeInfo Function

The JetOSSnapshotGetFreezeInfo function retrieves the list of instances and databases that are part of the snapshot session at any given moment.

Windows Vista:  JetOSSnapshotGetFreezeInfo is introduced in 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
    );

Parameters

snapId

The identifier of the snapshot session to be started.

pcInstanceInfo

The number of instances currently running that are part of the snapshot session.

paInstanceInfo

An array of structures, one for each running instance, describing the instance and the databases that are part of it.

grbit

The options for this call. This parameter is reserved for future use. The only valid value is 0 (zero).

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_errOutOfMemory The function failed due to an out-of-memory condition.
JET_errInvalidParameter pcInstanceInfo or paInstanceInfo is NULL.
JET_errOSSnapshotInvalidSnapId The identifier for the snapshot session is not valid.
JET_errOSSnapshotInvalidSequence A snapshot session is not in progress.

If this function succeeds, the instance information is properly filled and it must be freed later by calling JetFreeBuffer with the pointer to the instance info array that was returned.

If this function fails, no change in the engine state occurs.

Requirements
Requirement Value
Client Requires Windows Vista.
Server Requires Windows Server 2008.
Header Declared in Esent.h.
Library Use ESENT.lib.
DLL Requires ESENT.dll.
Unicode Implemented as JetOSSnapshotGetFreezeInfoW (Unicode) and JetOSSnapshotGetFreezeInfoA (ANSI).
See Also

Error Handling Parameters
Extensible Storage Engine Errors
JET_ERR
JetFreeBuffer
JetOSSnapshotAbort
JetOSSnapshotFreeze
JetOSSnapshotThaw

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)

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

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