达梦(DM)数据库函数dpi_get_diag_rec

dpi_get_diag_rec

函数

DPIRETURN

dpi_get_diag_rec(

sdint2 hndl_type,

dhandle hndl,

sdint2 rec_num,

sdint4 *err_code,

sdbyte *err_msg,

sdint2 buf_sz,

sdint2 *msg_len

);

功能

获取复合字段的诊断信息。

参数

hndl_type

输入参数，需要获取诊断信息的句柄类型。必须为下列值之一：

• DSQL_HANDLE_ENV
• DSQL_HANDLE_DBC
• DSQL_HANDLE_STMT
• DSQL_HANDLE_DESC
• DSQL_HANDLE_LOB_LOCATOR
• DSQL_HANDLE_OBJECT
• DSQL_HANDLE_OBJECTDESC

1) hndl

输入参数，需要取得诊断信息且由 hndl_type 所标示的句柄。

2) rec_num

输入参数，诊断信息的索引号。索引起始为 1。

3) err_code

输出参数，指向用于记录错误码的缓冲区的指针。此信息包含在

DSQL_DIAG_ERROR_CODE 诊断域中。

4) err_msg

输出参数，指向用于记录诊断消息缓冲区的指针。此信息包含在

DSQL_DIAG_MESSAGE_TEXT 诊断域中。

5) buf_sz

输入参数，err_msg 缓冲区的长度。

6) msg_len

输出参数，指向用于返回诊断消息总长度的缓冲区的指针。如果诊断消息长度大于等于

buf_sz，则诊断消息被截断且以 0 结尾。

返回值

DSQL_SUCCESS

DSQL_SUCCESS_WITH_INFO

DSQL_ERROR

DSQL_INVALID_HANDLE

DSQL_NO_DATA_FOUND

说明

函数返回值含义：

• DSQL_SUCCESS：函数成功返回诊断信息。
• DSQL_SUCCESS_WITH_INFO：err_msg 缓冲区长度不足，诊断信息被截断。
• DSQL_ERROR：发生了下列情况之一：

1. rec_num 小于等于 0。
2. buf_sz 小于 0。

• DSQL_INVALID_HANDLE：由 hndl_type 所标示的 hndl 为一个无效的句柄。
• DSQL_NO_DATA：rec_num 大于句柄所含有的诊断信息总数。