JetGetTruncateLogInfoInstance 函数

项目
06/13/2023

适用于： Windows |Windows Server

JetGetTruncateLogInfoInstance 函数

JetGetTruncateLogInfoInstance 函数在由 JetBeginExternalBackup 启动的备份期间使用，以查询实例，以获取在备份成功完成后可以安全删除的事务日志文件的名称。

Windows XP：JetGetTruncateLogInfoInstance 在 Windows XP 中引入。

    JET_ERR JET_API JetGetTruncateLogInfoInstance(
      __in          JET_INSTANCE instance,
      __out_opt     tchar* szz,
      __in          unsigned long cbMax,
      __out_opt     unsigned long* pcbActual
    );

parameters

instance

用于此调用的实例。

szz

接收以 null 结尾的字符串列表的输出缓冲区，描述在成功完成备份后可以安全删除的事务日志文件集。

此缓冲区中返回的字符串列表的格式与注册表使用的多字符串格式相同。每个以 null 结尾的字符串按顺序返回，后跟最终的 null 终止符。

cbMax

输出缓冲区的最大大小（以字节为单位）。

印刷品

指向接收实际字符串数据量的输出缓冲区的指针。

返回值

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

返回代码	说明
JET_errSuccess	操作已成功完成。
JET_errInvalidParameter	提供的其中一个参数包含意外值，或者多个参数值的组合导致意外结果。 Windows XP 及更高版本：当指定的实例句柄无效时，JetGetTruncateLogInfoInstance 可能会发生这种情况。
JET_errNotInitialized	操作无法完成，因为尚未初始化与会话关联的实例。
JET_errClientRequestToStopJetService	由于调用 JetStopService，与会话关联的实例上的所有活动都已停止，因此操作无法完成。
JET_errInstanceUnavailable	该操作无法完成，因为与会话关联的实例遇到一个致命错误，该错误要求撤销对所有数据的访问权限以保护该数据的完整性。 Windowsxp：此返回值是在 Windows XP 中引入的。
JET_errBackupAbortByServer	操作失败，因为调用 JetStopBackup 中止了当前外部备份。 Windowsxp：此返回值是在 Windows XP 中引入的。
JET_errInvalidBackupSequence	备份操作失败，因为它被按顺序调用。
JET_errNoBackup	操作失败，因为没有外部备份正在进行。
JET_errRestoreInProgress	该操作无法完成，因为正在对与会话关联的实例执行还原操作。
JET_errTermInProgress	操作无法完成，因为正在关闭与会话关联的实例。
JetGetTruncateLogInfoInstance	有未完成的文件句柄是使用 JetOpenFile 为实例创建的。

如果此函数成功，请求的有关在成功完成备份后可以安全删除的事务日志文件集的信息将放在提供它们的输出缓冲区中。备份状态机将处于高级状态，以便不再允许备份数据库文件。在此时间点之后，只能打开数据库修补程序文件和事务日志文件进行备份。

如果此函数失败，则输出缓冲区的状态为未定义。失败将导致取消实例的整个备份过程。

备注

如果输出缓冲区太小而无法接受应属于备份文件集的文件的完整列表，则此 API 不会返回错误或警告。应用程序应始终提供一个缓冲区来接收此列表的实际大小，并使用该信息来确定列表是否已截断。

要求

要求	值
客户端	需要 Windows Vista 或 Windows XP。
服务器	需要 Windows Server 2008 或 Windows Server 2003。
标头	在 Esent.h 中声明。
Library	使用 ESENT.lib。
DLL	需要ESENT.dll。
Unicode	实现为 JetGetTruncateLogInfoInstanceW (Unicode) 和 JetGetTruncateLogInfoInstanceA (ANSI) 。

另请参阅

JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetCloseDatabase
JetCloseTable
JetEndSession
JetOpenFile
JetResetSessionContext
JetRollback
JetStopBackup
JetStopService
JetTerm
JetTerm2

通过

JetGetTruncateLogInfoInstance 函数