VastbaseG100

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

Menu

SQLDescribeParam

功能描述

返回与已准备的 SQL 语句相关联的参数标记的说明。 此信息也可用于 IPD 的字段。

接口原型

RETCODE		SQL_API
SQLDescribeParam(HSTMT hstmt,
				 SQLUSMALLINT ipar,
				 SQLSMALLINT *pfSqlType,
				 SQLULEN *pcbParamDef,
				 SQLSMALLINT *pibScale,
				 SQLSMALLINT *pfNullable)

参数说明

参数名 参数说明
hstmt 语句句柄。
ipar 参数标记号按参数顺序递增,从1开始。
pfSqlType 指向缓冲区的指针,在该缓冲区中返回参数的SQL数据类型。
pcbParamDef 指向缓冲区的指针,在该缓冲区中返回数据源定义的相应参数标记的列或表达式的大小(以字符为单位)。
pibScale 指向缓冲区的指针,在该缓冲区中返回由数据源定义的列相应参数的表达式的十进制位数。
pfNullable 指向缓冲区的指针,将在此缓冲区中返回一个值,该值指示参数是否允许 NULL 值。 此值从 IPD 的 SQL_DESC_NULLABLE 字段中读取。 下列类型作之一:
  • SQL_NO_NULLS:该参数不允许 NULL 值 (这是) 默认值。
  • SQL_NULLABLE:参数允许空值。
  • SQL_NULLABLE_UNKNOWN:驱动程序无法确定参数是否允许空值。

返回

  • SQL_SUCCESS:表示调用正确。
  • SQL_ERROR:表示比较严重的错误,如:内存分配失败、建立连接失败等。
  • SQL_INVALID_HANDLE:表示调用无效句柄。其他API的返回值同理。

其他

无。