Класс IErrorRecordsImpl
Реализует интерфейс OLE DB IErrorRecords, добавляя записи в элементы данных (m_rgErrors) типа CAtlArray>RecordClass
< и извлекая записи.
Синтаксис
template <class T, class RecordClass = ATLERRORINFO>
class IErrorRecordsImpl : public IErrorRecords
Параметры
T
Класс, производный от IErrorRecordsImpl
.
RecordClass
Класс, представляющий объект ошибки OLE DB.
Требования
Заголовок: atldb.h
Участники
Методы
Имя | Описание |
---|---|
GetErrorDescriptionString | Возвращает строку описания ошибки из записи об ошибке. |
GetErrorGUID | Возвращает GUID ошибки из записи об ошибке. |
GetErrorHelpContext | Возвращает идентификатор контекста справки из записи об ошибке. |
GetErrorHelpFile | Возвращает полное имя пути файла справки из записи об ошибке. |
GetErrorSource | Возвращает исходный код ошибки из записи об ошибке. |
Методы интерфейса
Имя | Описание |
---|---|
AddErrorRecord | Добавляет запись в объект ошибки OLE DB. |
GetBasicErrorInfo | Возвращает основные сведения об ошибке, например код возврата и номер ошибки для конкретного поставщика. |
GetCustomErrorObject | Возвращает указатель на интерфейс в пользовательском объекте ошибки. |
GetErrorInfo | Возвращает указатель интерфейса IErrorInfo на указанную запись. |
GetErrorParameters | Возвращает параметры ошибки. |
GetRecordCount | Возвращает количество записей в объекте записи OLE DB. |
Элементы данных
Имя | Описание |
---|---|
m_rgErrors | Массив записей ошибок. |
IErrorRecordsImpl::GetErrorDescriptionString
Возвращает строку описания ошибки из записи об ошибке.
Синтаксис
LPOLESTR GetErrorDescriptionString(ERRORINFO& rCurError);
Параметры
rCurError
Запись ERRORINFO
в интерфейсе IErrorInfo
.
Возвращаемое значение
Указатель на строку, описывающую ошибку.
IErrorRecordsImpl::GetErrorGUID
Возвращает GUID ошибки из записи об ошибке.
Синтаксис
REFGUID GetErrorGUID(ERRORINFO& rCurError);
Параметры
rCurError
Запись ERRORINFO
в интерфейсе IErrorInfo
.
Возвращаемое значение
Ссылка на GUID для ошибки.
IErrorRecordsImpl::GetErrorHelpContext
Возвращает идентификатор контекста справки из записи об ошибке.
Синтаксис
DWORD GetErrorHelpContext(ERRORINFO& rCurError);
Параметры
rCurError
Запись ERRORINFO
в интерфейсе IErrorInfo
.
Возвращаемое значение
Идентификатор контекста справки для ошибки.
IErrorRecordsImpl::GetErrorHelpFile
Возвращает имя пути файла справки из записи об ошибке.
Синтаксис
LPOLESTR GetErrorHelpFile(ERRORINFO& rCurError);
Параметры
rCurError
Запись ERRORINFO
в интерфейсе IErrorInfo
.
Возвращаемое значение
Указатель на строку, содержащую имя пути файла справки для ошибки.
IErrorRecordsImpl::GetErrorSource
Возвращает исходный код, вызвавшего ошибку из записи об ошибке.
Синтаксис
LPOLESTR GetErrorSource(ERRORINFO& rCurError);
Параметры
rCurError
Запись ERRORINFO
в интерфейсе IErrorInfo
.
Возвращаемое значение
Указатель на строку, содержащую исходный код ошибки.
IErrorRecordsImpl::AddErrorRecord
Добавляет запись в объект ошибки OLE DB.
Синтаксис
STDMETHOD(AddErrorRecord )(ERRORINFO *pErrorInfo,
DWORD dwLookupID,
DISPPARAMS *pdispparams,
IUnknown *punkCustomError,
DWORD dwDynamicErrorID);
Параметры
См. раздел IErrorRecords::AddErrorRecord в справочнике программиста OLE DB.
IErrorRecordsImpl::GetBasicErrorInfo
Возвращает основные сведения об ошибке, например код возврата и номер ошибки для конкретного поставщика.
Синтаксис
STDMETHOD(GetBasicErrorInfo )(ULONG ulRecordNum,
ERRORINFO *pErrorInfo);
Параметры
См. статью IErrorRecords::GetBasicErrorInfo в справочнике программиста OLE DB.
IErrorRecordsImpl::GetCustomErrorObject
Возвращает указатель на интерфейс в пользовательском объекте ошибки.
Синтаксис
STDMETHOD(GetCustomErrorObject )(ULONG ulRecordNum,
REFIID riid,
IUnknown **ppObject);
Параметры
См. раздел IErrorRecords::GetCustomErrorObject в справочнике программиста OLE DB.
IErrorRecordsImpl::GetErrorInfo
Возвращает указатель интерфейса IErrorInfo на указанную запись.
Синтаксис
STDMETHOD(GetErrorInfo )(ULONG ulRecordNum,
LCID lcid,
IErrorInfo **ppErrorInfo);
Параметры
См. раздел IErrorRecords::GetErrorInfo в справочнике программиста OLE DB.
IErrorRecordsImpl::GetErrorParameters
Возвращает параметры ошибки.
Синтаксис
STDMETHOD(GetErrorParameters )(ULONG ulRecordNum,
DISPPARAMS *pdispparams);
Параметры
См. раздел IErrorRecords::GetErrorParameters в справочнике программиста OLE DB.
IErrorRecordsImpl::GetRecordCount
Возвращает количество записей в объекте записи OLE DB.
Синтаксис
STDMETHOD(GetRecordCount )(ULONG *pcRecords);
Параметры
См. раздел IErrorRecords::GetRecordCount в справочнике программиста OLE DB.
IErrorRecordsImpl::m_rgErrors
Массив записей ошибок.
Синтаксис
CAtlArray< RecordClass > m_rgErrors;
См. также
Шаблоны поставщика OLE DB
Архитектура шаблона поставщика OLE DB