CDBErrorInfo 类
支持使用 OLE DB IErrorRecords 接口处理 OLE DB 错误。
语法
class CDBErrorInfo
要求
标头: atldbcli.h
成员
方法
| 名称 | 描述 |
|---|---|
| GetAllErrorInfo | 返回错误记录中包含的所有错误信息。 |
| GetBasicErrorInfo | 调用 IErrorRecords::GetBasicErrorInfo 可返回有关指定错误的基本信息。 |
| GetCustomErrorObject | 调用 IErrorRecords::GetCustomErrorObject 可返回指向自定义错误对象上的接口的指针。 |
| GetErrorInfo | 调用 IErrorRecords::GetErrorInfo 可返回指向指定记录的 IErrorInfo 接口指针。 |
| GetErrorParameters | 调用 IErrorRecords::GetErrorParameters 可返回错误参数。 |
| GetErrorRecords | 获取指定对象的错误记录。 |
注解
此接口可向用户返回一个或多个错误记录。 首先调用 CDBErrorInfo::GetErrorRecords 以获取错误记录计数。 然后调用其中一个访问函数（例如 CDBErrorInfo::GetAllErrorInfo）来检索每个记录的错误信息。
CDBErrorInfo::GetAllErrorInfo
返回错误记录中包含的所有类型的错误信息。
语法
HRESULT GetAllErrorInfo(ULONG ulRecordNum,
LCID lcid, BSTR* pbstrDescription,
BSTR* pbstrSource = NULL,
GUID* pguid = NULL,
DWORD* pdwHelpContext = NULL,
BSTR* pbstrHelpFile = NULL) const throw();
参数
ulRecordNum
[in] 为其返回错误信息的记录的从零开始的数字。
lcid
[in] 要返回的错误信息的区域设置 ID。
pbstrDescription
[out] 当不支持区域设置时，指向错误或 NULL 的文本说明的指针。 请参阅“备注”。
pbstrSource
[out] 一个指针，该指针指向包含产生错误的组件的名称的字符串。
pguid
[out] 一个指针，该指针指向定义错误的接口的 GUID。
pdwHelpContext
[out] 指向错误的帮助上下文 ID 的指针。
pbstrHelpFile
[out] 一个指针，该指针指向包含描述错误的帮助文件的路径的字符串。
返回值
如果成功，则为 S_OK。 有关其他返回值，请参阅“OLE DB 程序员参考”中的 IErrorRecords::GetErrorInfo。
注解
pbstrDescription 的输出值通过调用 IErrorInfo::GetDescription 在内部获得，如果不支持区域设置或者同时满足以下两个条件，则此调用会将输出值设置为 NULL：
lcid 的值不是“U.S. English”且
lcid 的值不等于 GetUserDefaultLCID 返回的值。
CDBErrorInfo::GetBasicErrorInfo
调用 IErrorRecords::GetBasicErrorInfo 可返回有关错误的基本信息，例如返回代码和特定于提供程序的错误号。
语法
HRESULT GetBasicErrorInfo(ULONG ulRecordNum,
ERRORINFO* pErrorInfo) const throw();
参数
请参阅“OLE DB 程序员参考”中的 IErrorRecords::GetBasicErrorInfo。
返回值
标准 HRESULT。
CDBErrorInfo::GetCustomErrorObject
调用 IErrorRecords::GetCustomErrorObject 可返回指向自定义错误对象上的接口的指针。
语法
HRESULT GetCustomErrorObject(ULONG ulRecordNum,
REFIID riid,IUnknown** ppObject) const throw();
参数
请参阅《OLE DB 程序员参考》中的 IErrorRecords::GetCustomErrorObject。
返回值
标准 HRESULT。
CDBErrorInfo::GetErrorInfo
调用 IErrorRecords::GetErrorInfo 可返回指向指定记录的 IErrorInfo 接口指针。
语法
HRESULT GetErrorInfo(ULONG ulRecordNum,
LCID lcid,IErrorInfo** ppErrorInfo) const throw();
参数
请参阅《OLE DB 程序员参考》中的 IErrorRecords::GetErrorInfo。
返回值
标准 HRESULT。
CDBErrorInfo::GetErrorParameters
调用 IErrorRecords::GetErrorParameters 可返回错误参数。
语法
HRESULT GetErrorParameters(ULONG ulRecordNum,
DISPPARAMS* pdispparams) const throw();
参数
请参阅“OLE DB 程序员参考”中的 IErrorRecords::GetErrorParameters。
返回值
标准 HRESULT。
CDBErrorInfo::GetErrorRecords
获取指定对象的错误记录。
语法
HRESULT GetErrorRecords(IUnknown* pUnk,
const IID& iid,
ULONG* pcRecords) throw();
HRESULT GetErrorRecords(ULONG* pcRecords) throw();
参数
pUnk
[in] 指向要为其获取错误记录的对象的接口。
iid
[in] 与错误关联的接口的 IID。
pcRecords
[out] 指向错误记录计数（从 1 开始）的指针。
返回值
标准 HRESULT。
注解
如果要检查从哪个接口获取错误信息，请使用此函数的第一种形式。 否则，请使用第二种形式。