SQLGetDiagField
功能描述
返回诊断数据结构的记录字段的当前值， (与包含错误、警告和状态信息的指定句柄) 相关联。
接口原型
RETCODE SQL_API
SQLGetDiagField(SQLSMALLINT HandleType,
SQLHANDLE Handle,
SQLSMALLINT RecNumber,
SQLSMALLINT DiagIdentifier,
PTR DiagInfo,
SQLSMALLINT BufferLength,
SQLSMALLINT *StringLength)
参数说明
| 参数名 | 参数说明 |
|---|---|
| HandleType | 一个句柄类型标识符，描述需要诊断的句柄的类型。 必须是下列选项之一：
|
| Handle | HandleType 指示的类型的诊断数据结构的句柄。 如果 SQL_HANDLE_ENV HandleType ，则 句柄 可以是共享或非共享环境句柄。 |
| RecNumber | 指示应用程序从中查找信息的状态记录。 状态记录从1开始编号。如果DiagIdentifier参数指示诊断标头的任何字段，则将忽略RecNumber。如果不是，则它应大于0。 |
| DiagIdentifier | 指示要返回其值的诊断字段。 |
| DiagInfo | 指向要返回诊断信息的缓冲区的指针。数据类型取决于DiagIdentifier的值。如果DiagInfo是整数类型，则在调用此函数之前，应用程序应使用sqlulen生成的缓冲区并将值初始化为0，因为某些驱动程序只能写入缓冲区中的较低32位或16位，并使高阶位保持不变。 |
| BufferLength | DiagInfo指向的缓冲区的大小。 |
| StringLength | 指向缓冲区的指针，该缓冲区用于返回DiagInfo中用于返回字符数据的总字节数(不包括null终止字符所需的字节数)。如果可返回的字节数大于或等于BufferLength，则DiagInfo中的文本将被截断为BufferLength减去null字符的长度。 |
返回
- SQL_SUCCESS：表示调用正确。
- SQL_SUCCESS_WITH_INFO：表示会有一些警告信息。
- SQL_ERROR：表示比较严重的错误，如：内存分配失败、建立连接失败等。
其他
无。
