IErrorRecordsImpl 类
实现 OLE DB IErrorRecords 接口,向 CAtlArrayRecordClass
类型的数据成员 (m_rgErrors) 添加记录和从中检索记录。<>
语法
template <class T, class RecordClass = ATLERRORINFO>
class IErrorRecordsImpl : public IErrorRecords
参数
T
派生自 IErrorRecordsImpl
的类。
RecordClass
一个表示 OLE DB 错误对象的类。
要求
标头: atldb.h
成员
方法
名称 | 描述 |
---|---|
GetErrorDescriptionString | 从错误记录中获取错误说明字符串。 |
GetErrorGUID | 从错误记录中获取错误 GUID。 |
GetErrorHelpContext | 从错误记录中获取帮助上下文 ID。 |
GetErrorHelpFile | 从错误记录中获取帮助文件的完整路径名。 |
GetErrorSource | 从错误记录中获取错误源代码。 |
接口方法
名称 | 描述 |
---|---|
AddErrorRecord | 将记录添加到 OLE DB 错误对象。 |
GetBasicErrorInfo | 返回有关错误的基本信息,例如返回代码和特定于提供程序的错误号。 |
GetCustomErrorObject | 返回指向自定义错误对象上的接口的指针。 |
GetErrorInfo | 返回指定记录上的 IErrorInfo 接口指针。 |
GetErrorParameters | 返回错误参数。 |
GetRecordCount | 返回 OLE DB 记录对象中的记录数。 |
数据成员
名称 | 描述 |
---|---|
m_rgErrors | 错误记录数组。 |
IErrorRecordsImpl::GetErrorDescriptionString
从错误记录中获取错误说明字符串。
语法
LPOLESTR GetErrorDescriptionString(ERRORINFO& rCurError);
参数
rCurError
IErrorInfo
接口中的 ERRORINFO
记录。
返回值
指向描述错误的字符串的指针。
IErrorRecordsImpl::GetErrorGUID
从错误记录中获取错误 GUID。
语法
REFGUID GetErrorGUID(ERRORINFO& rCurError);
参数
rCurError
IErrorInfo
接口中的 ERRORINFO
记录。
返回值
对错误的 GUID 的引用。
IErrorRecordsImpl::GetErrorHelpContext
从错误记录中获取帮助上下文 ID。
语法
DWORD GetErrorHelpContext(ERRORINFO& rCurError);
参数
rCurError
IErrorInfo
接口中的 ERRORINFO
记录。
返回值
错误的帮助上下文 ID。
IErrorRecordsImpl::GetErrorHelpFile
从错误记录中获取帮助文件的路径名。
语法
LPOLESTR GetErrorHelpFile(ERRORINFO& rCurError);
参数
rCurError
IErrorInfo
接口中的 ERRORINFO
记录。
返回值
指向包含错误帮助文件路径名的字符串的指针。
IErrorRecordsImpl::GetErrorSource
从错误记录中获取导致错误的源代码。
语法
LPOLESTR GetErrorSource(ERRORINFO& rCurError);
参数
rCurError
IErrorInfo
接口中的 ERRORINFO
记录。
返回值
指向包含错误源代码的字符串的指针。
IErrorRecordsImpl::AddErrorRecord
将记录添加到 OLE DB 错误对象。
语法
STDMETHOD(AddErrorRecord )(ERRORINFO *pErrorInfo,
DWORD dwLookupID,
DISPPARAMS *pdispparams,
IUnknown *punkCustomError,
DWORD dwDynamicErrorID);
参数
请参阅《OLE DB 程序员参考》中的 IErrorRecords::AddErrorRecord。
IErrorRecordsImpl::GetBasicErrorInfo
返回有关错误的基本信息,例如返回代码和特定于提供程序的错误号。
语法
STDMETHOD(GetBasicErrorInfo )(ULONG ulRecordNum,
ERRORINFO *pErrorInfo);
参数
请参阅“OLE DB 程序员参考”中的 IErrorRecords::GetBasicErrorInfo。
IErrorRecordsImpl::GetCustomErrorObject
返回指向自定义错误对象上的接口的指针。
语法
STDMETHOD(GetCustomErrorObject )(ULONG ulRecordNum,
REFIID riid,
IUnknown **ppObject);
参数
请参阅《OLE DB 程序员参考》中的 IErrorRecords::GetCustomErrorObject。
IErrorRecordsImpl::GetErrorInfo
返回指定记录上的 IErrorInfo 接口指针。
语法
STDMETHOD(GetErrorInfo )(ULONG ulRecordNum,
LCID lcid,
IErrorInfo **ppErrorInfo);
参数
请参阅《OLE DB 程序员参考》中的 IErrorRecords::GetErrorInfo。
IErrorRecordsImpl::GetErrorParameters
返回错误参数。
语法
STDMETHOD(GetErrorParameters )(ULONG ulRecordNum,
DISPPARAMS *pdispparams);
参数
请参阅“OLE DB 程序员参考”中的 IErrorRecords::GetErrorParameters。
IErrorRecordsImpl::GetRecordCount
返回 OLE DB 记录对象中的记录数。
语法
STDMETHOD(GetRecordCount )(ULONG *pcRecords);
参数
请参阅《OLE DB 程序员参考》中的 IErrorRecords::GetRecordCount。
IErrorRecordsImpl::m_rgErrors
错误记录数组。
语法
CAtlArray< RecordClass > m_rgErrors;