Db2 for i CLI 函数

这些 Db2 for i 调用级接口 API 可用于在 IBM i 操作系统上访问数据库。 每个 Db2 for i CLI 函数描述都以一致的格式提供。

请参阅 Db2 for i CLI 的类别以获取函数的分类列表。

如何描述 CLI 功能

下表显示了函数描述的每个部分中描述的信息类型。

类型 描述
目的 本节简要概述了该函数的作用。 它还指示在调用所描述的函数之前和之后是否应该调用任何函数。
语法

本部分包含 IBM i 环境的 C 语言原型。

参数 本部分列出了每个函数自变量及其数据类型,描述以及它是输入还是输出自变量。

每个 Db2 for i CLI 参数都是输入或输出参数。 除了 SQLGetInfo()之外, Db2 for i CLI 仅修改指示为输出的自变量。

某些函数包含称为 deferredbound 参数的输入或输出参数。 这些参数是指向应用程序分配的缓冲区的指针。 这些自变量与 (或绑定到) SQL 语句中的参数或结果集中的列相关联。 Db2 for i CLI 稍后将访问该函数指定的数据区。 在 Db2 for i CLI 访问这些延迟数据区时,这些数据区仍然有效非常重要。

用法 本部分提供了有关如何使用该功能以及任何特殊注意事项的信息。 此处不讨论可能的错误情况,而是在诊断部分中列出。
返回码

此部分列出了所有可能的函数返回码。 返回 SQL_ERROR 或 SQL_SUCCESS_WITH_INFO 时,可通过调用 SQLError()获取错误信息。

有关返回码的更多信息,请参阅 Db2 for i CLI 应用程序中的诊断

诊断

此部分包含一个表,其中列出了 Db2 for i CLI 显式返回的 SQLSTAT (也可能返回了由数据库管理系统 (DBMS) 生成的 SQLSTAT) ,并指示错误原因。 通过在函数返回 SQL_ERROR 或 SQL_SUCCESS_WITH_INFO 后调用 SQLError() 来获取这些值。

第一列中的 * 指示 SQLSTATE 仅由 Db2 for i CLI 返回,而不是由其他 ODBC 驱动程序返回。

有关诊断的更多信息,请参阅 Db2 for i CLI 应用程序中的诊断

限制 本部分指示 Db2 for i CLI 和 ODBC 之间可能影响应用程序的任何差异或限制。
示例 此部分是演示函数使用的代码片段。 示例: Db2 for i CLI 应用程序中列出了用于所有代码片段的完整源。
引用 本部分列出了相关的 Db2 for i CLI 功能。