JetOSSnapshotGetFreezeInfo 函数
适用于: Windows |Windows Server
JetOSSnapshotGetFreezeInfo 函数
JetOSSnapshotGetFreezeInfo 函数在任何给定时刻检索属于快照会话的实例和数据库的列表。
Windows Vista:JetOSSnapshotGetFreezeInfo 在 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
要启动的快照会话的标识符。
pcInstanceInfo
当前运行的、属于快照会话的实例数。
paInstanceInfo
结构数组,每个正在运行的实例对应一个结构,描述该实例及其所属的数据库。
grbit
此调用的选项。 此参数留待将来使用。 唯一有效的值为 0 (零) 。
返回值
此函数返回具有以下返回代码之一 的JET_ERR 数据类型。 有关可能的 ESE 错误的详细信息,请参阅 可扩展存储引擎错误 和 错误处理参数。
返回代码 |
说明 |
---|---|
JET_errSuccess |
操作已成功完成。 |
JET_errOutOfMemory |
函数由于内存不足而失败。 |
JET_errInvalidParameter |
pcInstanceInfo 或 paInstanceInfo 为 NULL。 |
JET_errOSSnapshotInvalidSnapId |
快照会话的标识符无效。 |
JET_errOSSnapshotInvalidSequence |
快照会话未进行。 |
如果此函数成功,则实例信息将被正确填充,并且稍后必须通过调用 JetFreeBuffer 和指向返回的实例信息数组的指针来释放该信息。
如果此函数失败,则不会更改引擎状态。
要求
要求 | 值 |
---|---|
客户端 |
需要 Windows Vista。 |
服务器 |
需要 Windows Server 2008。 |
标头 |
在 Esent.h 中声明。 |
Library |
使用 ESENT.lib。 |
DLL |
需要ESENT.dll。 |
Unicode |
实现为 JetOSSnapshotGetFreezeInfoW (Unicode) 和 JetOSSnapshotGetFreezeInfoA (ANSI) 。 |
另请参阅
错误处理参数
可扩展存储引擎错误
JET_ERR
JetFreeBuffer
JetOSSnapshotAbort
JetOSSnapshotFreeze
JetOSSnapshotThaw