VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

SQLGetDescField

功能描述

返回单个描述符字段的值。

接口原型

RETCODE		SQL_API
SQLGetDescField(SQLHDESC DescriptorHandle,
				SQLSMALLINT RecNumber, 
                SQLSMALLINT FieldIdentifier,
				PTR Value, 
                SQLINTEGER BufferLength,
				SQLINTEGER *StringLength)

参数说明

参数名 参数说明
DescriptorHandle 描述符句柄。
RecNumber 指示应用程序从其中查找信息的描述符记录。 描述符记录从 0 编号,记录编号 0 作为书签记录。 如果 FieldIdentifier 参数指示标头字段,则忽略 RecNumber。 如果 RecNumber 小于或等于 SQL_DESC_COUNT但该行不包含列或参数的数据,则调用 SQLGetDescField 将返回字段的默认值。
FieldIdentifier 指示要返回其值的描述符的字段。
Value 指向要返回描述符信息的缓冲区的指针。 数据类型取决于 FieldIdentifier 的值。
BufferLength 没有用到此参数。
StringLength 范围Value的长度,如果Value是整数,则返回对应的sizeof(类型),如果Value是指针类型,则返回对应字符串的长度。

返回值

  • SQL_SUCCESS:表示调用正确。
  • SQL_ERROR:表示比较严重的错误,如:内存分配失败、建立连接失败等。

其他

无。