文档中心

SQLColAttribute函数 ​

功能 ​

本函数用于输出列绑定之前，获知所需绑定的输出列的大小，绑定的列名等等用户需要的列属性，辅助用户进行绑定时的参数设置。

函数原型 ​

c
SQLRETURN SQLColAttribute (
      SQLHSTMT 			StatementHandle,
      SQLUSMALLINT 		ColumnNumber,
      SQLUSMALLINT 		FieldIdentifier,
      SQLPOINTER 		CharacterAttributePtr,
      SQLSMALLINT 		BufferLength,
      SQLSMALLINT * 	StringLengthPtr,
      SQLLEN * 			NumericAttributePtr);

参数解释 ​

  • StatementHandle：语句句柄。
  • ColumnNumber：列序号（从1开始）。
  • FieldIdentifier：用户需要得到的列的属性标识。
  • CharacterAttributePtr：该参数在序列号为ColumnNumber的输出列的FieldIdentifier属性所指定的输出值为string时，指定一块buffer以供输出使用。当FieldIdentifier所指定的属性值不是string类型时，该参数无效。
  • BufferLength：当FieldIdentifier指定的属性值由CharacterAttributePtr提供输出时，BufferLength指定输出字串的buffer长度大小，单位为字节。
  • StringLengthPtr：指向buff的返回值的字节大小数。
  • NumericAttributePtr：该参数在序列号为ColumnNumber的输出列的FieldIdentifier属性所指定的输出值为数值型的描述值时，由该属性来完成属性值的输出功能。

返回值 ​

成功时返回SQL_SUCCESS。