DB2 CLI 函数描述的关键

每个函数描述包含下列各节：

用途

本节给出函数功能的简要概述。还指示在调用所描述的函数之前或之后是否应调用任何函数。

每个函数还有一个表，该表指示函数符合的规范或标准。

此表指示函数的支持。一些函数使用的选项集不适用于所有规范或标准。函数的限制部分标识了任何明显差异。

语法

本节包含类属‘C’原型。该类属原型用于所有环境，包括 Windows。

所有作为指针的函数自变量都是使用宏 FAR 定义的，对于除 Windows 外的所有平台，此宏被定义为不存在（设置为空白）。在 Windows 上，FAR 用来将指针自变量定义为 far 指针。

自变量

本节列示每个函数自变量及其数据类型和描述，并指出它是输入自变量还是输出自变量。

一些函数包含输入或输出自变量（也称为延迟或绑定自变量）。

这些自变量是指向由应用程序分配的缓冲区的指针，且与 SQL 语句中的参数或结果集中的列相关联（或与这些参数或列绑定）。稍后，DB2 CLI 存取函数指定的数据区。在 DB2 CLI 存取这些延迟数据区时， 它们必须仍然有效。

用法

本节提供有关如何使用函数的信息以及任何特殊注意事项。可能的错误状态不在此处讨论，而是列示在『诊断』一节中。

返回码

本节列示所有可能的函数返回码。当返回 SQL_ERROR 或 SQL_SUCCESS_WITH_INFO 时，可通过调用 SQLError() 或 SQLGetDiagRec() 来获取错误信息。

诊断

本节包含列示由 DB2 CLI 显式返回的 SQLSTATE（也可能返回由 DBMS 生成的 SQLSTATE） 并指示错误原因的表。在函数返回 SQL_ERROR 或 SQL_SUCCESS_WITH_INFO 后，可通过调用 SQLError() 或 SQLGetDiagRec() 来获取这些值。

限制

本节指示 DB2 Everyplace CLI 与 ODBC 之间可能影响应用程序的任何差异或限制。

请参阅 IBM DB2 Universal Database Call Level Interface Guide and Reference 以获取有关 DB2 CLI 的更多信息，包括有关返回码、诊断、示例、设置 CLI 环境和访问样本应用程序的信息。

相关参考

• 由 DB2 CLI 函数进行的数据转换
• DB2 CLI 函数摘要