更新日期:2024年09月11日
SQLColAttribute
功能描述
返回结果集中一列的描述符信息。
原型
SQLRETURN SQLColAttibute(SQLHSTMT
StatementHandle,
SQLUSMALLINT ColumnNumber,
SQLUSMALLINT
FieldIdentifier,
SQLPOINTER CharacterAtrriburePtr,
SQLSMALLINT
BufferLength,
SQLSMALLINT
*StringLengthPtr,
SQLLEN *NumericAttributePtr);
参数
表8-19 SQLColAttribute 参数
关键字
参数说明
SQLColAttribute
语句句柄。
SQLColAttribute
要检索字段的列号,起始为1,依次递增。
SQLColAttribute
IRD 中ColumnNumber 行的字段。
SQLColAttribute
输出参数:一个缓冲区指针,返回FieldIdentifier 字段值。
SQLColAttribute
如果FieldIdentifier 是一个ODBC 定义的字段,而且
CharacterAttributePtr 指向一个字符串或二进制缓冲区,则
此参数为该缓冲区的长度。
GBase 8c V5 开发者手册
南大通用数据技术股份有限公司
255
如果FieldIdentifier 是一个ODBC 定义的字段,而且
CharacterAttributePtr 指向一个整数,则会忽略该字段。
SQLColAttribute
输出参数:缓冲区指针,存放*CharacterAttributePtr 中字符类
型数据的字节总数,
对于非字符类型,
忽略BufferLength 的值。
NumericAttributePt r
输出参数:指向一个整型缓冲区的指针,返回IRD 中
ColumnNumber 行FieldIdentifier 字段的值。
返回值
SQL_SUCCESS:表示调用正确。
SQL_SUCCESS_WITH_INFO:表示会有一些警告信息。
SQL_ERROR:表示比较严重的错误,如:内存分配失败、建立连接失败等。
SQL_INVALID_HANDLE:表示调用无效句柄。其他API 的返回值同理。
注意事项
当SQLColAttribute 返回SQL_ERROR 或SQL_SUCCESS_WITH_INFO 时,通过调用
SQLGetDiagRec 函数,并将HandleType 和Handle 参数设置为SQL_HANDLE_STMT 和
StatementHandle,
可得到一个相关的SQLSTATE 值,
通过SQLSTATE 值可以查出调用此函
数的具体信息。
示例
参见8.2.23 示例。