JetOSSnapshotTruncateLogInstance 函数

适用于: Windows |Windows Server

JetOSSnapshotTruncateLogInstance 函数

JetOSSnapshotTruncateLogInstance 函数在快照会话期间截断指定实例的日志。

Windows Vista:JetOSSnapshotTruncateLogInstance 在 Windows Vista 中引入。

    JET_ERR JET_API JetOSSnapshotTruncateLogInstance(
      __in          const JET_OSSNAPID snapId,
      __in          JET_INSTANCE instance,
      __in          const JET_GRBIT grbit
    );

参数

snapId

快照会话的标识符。

instance

将用于此调用的 实例。

grbit

此调用的选项。 此参数可以具有以下值的组合。

grbit 可以是以下值之一:

含义

JET_bitAllDatabasesSnapshot

附加所有数据库,以便存储引擎可以计算并执行日志截断。

0(零)

不会发生截断。

返回值

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

返回代码

说明

JET_errSuccess

操作已成功完成。

JET_errInvalidGrbit

grbit 参数无效。

JET_errOSSnapshotInvalidSequence

快照会话不处于可能发生截断的状态。 可能的原因包括:

  • 调用在快照会话超时后完成。

  • 会话已指定为副本快照。

如果此函数成功,则属于快照会话的一个或所有实例的日志文件将被截断(如果可能)。

备注

仅当使用 JET_bitContinueAfterThaw 选项创建快照时,才应调用此函数。 否则,快照会话在调用 JetOSSnapshotThaw 后结束。

要求

要求

客户端

需要 Windows Vista。

服务器

需要 Windows Server 2008。

标头

在 Esent.h 中声明。

Library

使用 ESENT.lib。

DLL

需要ESENT.dll。

另请参阅

错误处理参数
可扩展存储引擎错误
JET_ERR
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw