JetGetAttachInfoInstance 函数

项目
06/13/2023

适用于： Windows |Windows Server

JetGetAttachInfoInstance 函数

JetGetAttachInfoInstance 函数在 JetBeginExternalBackupInstance 发起的备份期间使用，用于查询应成为备份文件集一部分的数据库文件的名称的实例。仅考虑当前使用 JetAttachDatabase 附加到实例的数据库。随后可以使用 JetOpenFileInstance 打开这些文件，并使用 JetReadFileInstance 读取这些文件。

Windows XP：JetGetAttachInfoInstance 在 Windows XP 中引入。

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

parameters

instance

要用于此调用的实例。

对于 Windows 2000，接受此参数的 API 变体不可用，因为仅支持一个实例。在本例中隐含使用此全局实例。

对于 Windows XP 及更高版本，仅当引擎处于旧模式 (Windows 2000 兼容模式时，才可调用不接受此参数的 API 变体) 其中仅支持一个实例。否则，操作将失败并JET_errRunningInMultiInstanceMode。

szz

接收以 null 结尾的字符串列表的输出缓冲区，这些字符串描述应是备份文件集的一部分的数据库文件集。此缓冲区中返回的字符串列表的格式与注册表使用的多字符串格式相同。每个以 null 结尾的字符串按顺序返回，后跟最终的 null 终止符。

cbMax

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

2013

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

返回值

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

返回代码	说明
JET_errSuccess	操作已成功完成。
JET_errBackupAbortByServer	操作失败，因为调用 JetStopBackupInstance 中止了当前外部备份。此错误仅由 Windows XP 及更高版本返回。
JET_errClientRequestToStopJetService	无法完成操作，因为与会话关联的实例上的所有活动都因调用 JetStopServiceInstance 而停止。
JET_errInstanceUnavailable	无法完成操作，因为与会话关联的实例遇到严重错误，要求撤销对所有数据的访问权限以保护该数据的完整性。此错误仅由 Windows XP 及更高版本返回。
JET_errInvalidBackupSequence	备份操作失败，因为它被按顺序调用。如果当前备份不是完整备份，JetGetAttachInfoInstance 将返回此错误。
JET_errInvalidParameter	提供的其中一个参数包含意外值，或者包含与另一个参数的值组合时没有意义的值。当指定的实例句柄 (Windows XP 和更高版本) 时， JetGetAttachInfoInstance 可能会发生这种情况。
JET_errNoBackup	操作失败，因为没有正在进行的外部备份。
JET_errNotInitialized	无法完成操作，因为与会话关联的实例尚未初始化。
JET_errRestoreInProgress	无法完成该操作，因为正在对与会话关联的实例执行还原操作。
JET_errRunningInMultiInstanceMode	操作失败，因为尝试在旧模式下使用引擎， (Windows 2000 兼容模式) 其中仅支持一个实例，而实际上已存在多个实例。
JET_errTermInProgress	无法完成操作，因为正在关闭与会话关联的实例。

成功后，应属于备份文件集的数据库文件集所请求的信息将放置在提供的输出缓冲区中。

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

备注

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

要求

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

另请参阅

JET_ERR
JET_INSTANCE
JetAttachDatabase
JetBeginExternalBackupInstance
JetOpenFileInstance
JetReadFileInstance
JetStopBackupInstance
JetStopServiceInstance

通过

JetGetAttachInfoInstance 函数