达梦(DM)数据库函数dpi_get_desc_field

dpi_get_desc_field

函数

DPIRETURN

dpi_get_desc_field(

dhdesc dpi_desc,

sdint2 rec_num,

sdint2 field,

dpointer val,

sdint4 val_len,

sdint4 *str_len

);

功能

获取单个描述符记录的域的当前值或设置。

参数：

1) dpi_desc

输入参数，描述符句柄。

2) rec_num

输入参数，包含所要获取域的描述符记录的索引号。此参数从 0 起始。当为 0 时，表示

所设置的为书签列。此参数值必须大于等于 0 且小于等于 DSQL_DESC_COUNT 的值。

3) field

输入参数，需要获取值的描述符域。详见函数 dpi_set_desc_field。

4) val

输出参数，指向返回描述信息的缓冲区的指针。数据类型依赖于 field。

5) val_len

输入参数，如果 val 返回的是字符串类型的值，则此参数表示 val 缓冲区的字节长度。

如果 val 返回的整形数，则此参数被忽略。

6) str_len

输出参数，指向返回 val 中可填充的最大字符串的字节长度的缓冲区指针。

返回值

DSQL_SUCCESS

DSQL_SUCCES_WITH_INFO

DSQL_ERROR

DSQL_INVALID_HANDLE

DSQL_NO_DATA

说明：

具体参见 dpi_set_desc_field 说明。