SQLColAttribute
功能描述
返回结果集中一列的描述符信息。
原型
1 2 3 4 5 6 7 |
SQLRETURN SQLColAttibute(SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLUSMALLINT FieldIdentifier, SQLPOINTER CharacterAtrriburePtr, SQLSMALLINT BufferLength, SQLSMALLINT *StringLengthPtr, SQLPOINTE NumericAttributePtr); |
参数
关键字 |
参数说明 |
---|---|
StatementHandle |
语句句柄。 |
ColumnNumber |
要检索字段的列号,起始为1,依次递增。 |
FieldIdentifier |
IRD中ColumnNumber行的字段。 |
CharacterAttributePtr |
输出参数:一个缓冲区指针,返回FieldIdentifier字段值。 |
BufferLength |
|
StringLengthPtr |
输出参数:缓冲区指针,存放*CharacterAttributePtr中字符类型数据的字节总数,对于非字符类型,忽略BufferLength的值。 |
NumericAttributePtr |
输出参数:指向一个整型缓冲区的指针,返回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值可以查出调用此函数的具体信息。
示例
参见:示例