SQLGetConnectOption - 返回连接选项的当前设置

不推荐使用 SQLGetConnectOption() ,并将其替换为 SQLGetConnectAttr()。 虽然此版本的 Db2 for i CLI 继续支持 SQLGetConnectOption(),但建议您开始在 Db2 for i CLI 程序中使用 SQLGetConnectAttr(),以便它们符合最新标准。

SQLGetConnectOption() 返回指定连接选项的当前设置。

这些选项是使用 SQLSetConnectOption() 函数设置的。

Unicode (UTF-16) 等效: 此函数还可以与 Unicode (UTF-16) 字符集配合使用。 对应的 Unicode 函数为 SQLGetConnectOptionW()。 请参阅 Db2 for i CLI 中的 Unicode ,以获取有关 DB2® CLI 的 Unicode 支持的更多信息。

语法

SQLRETURN SQLGetConnectOption( HDBC         hdbc,
                               SQLSMALLINT  fOption,
                               SQLPOINTER   pvParam);

函数自变量

表 1. SQLGetConnectOption参数
数据类型 自变量/参数 使用 描述
HDBC hdbc 输入 连接句柄。
SQLSMALLINT fOption 输入 要检索的选项。 有关更多信息,请参阅 表 2
SQLPOINTER pvParam 输出 fOption 关联的值,取决于 fOption 的值,它可以是一个 32 位整数值,也可以是一个指向空端字符串的指针。 返回的任何字符串的最大长度为 SQL_MAX_OPTION_STRING_LENGTH 字节 (不包括 null 终止字节)。

用法

SQLGetConnectOption() 提供与 SQLGetConnectAttr()相同的功能。 出于兼容性原因,这两个功能都受支持。

无法通过 SQLGetConnectOption()检索语句选项设置。

诊断

表 2。 SQLGetConnectOption SQLSTATEs
SQLSTATE 描述 说明
08003 连接未打开 指定了需要打开连接的 fOption 值。
HY001 内存分配失败 驱动程序无法分配支持功能处理或完成所需的内存。
HY009 选项类型超出范围 指定了无效的 fOption 值。

自变量 pvParam 是空指针。

HYC00 驱动程序不支持 fOption 参数可识别,但不受支持。

引用

SQLGetConnectAttr - 获取连接属性值