Класс CDBErrorInfo
Предоставляет поддержку обработки ошибок OLE DB с помощью интерфейса OLE DB IErrorRecords .
Синтаксис
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] Идентификатор языкового стандарта для возвращаемых сведений об ошибке.
pbstrDescription
[out] Указатель на текстовое описание ошибки или NULL, если языковой стандарт не поддерживается. См. заметки.
pbstrSource
[out] Указатель на строку, содержащую имя компонента, создающего ошибку.
pguid
[out] Указатель на GUID интерфейса, определяющего ошибку.
pdwHelpContext
[out] Указатель на идентификатор контекста справки для ошибки.
pbstrHelpFile
[out] Указатель на строку, содержащую путь к файлу справки, описывающего ошибку.
Возвращаемое значение
S_OK в случае успешного выполнения. См. раздел IErrorRecords::GetErrorInfo в справочнике программиста OLE DB для других возвращаемых значений.
Замечания
Выходное значение pbstrDescription получается внутренне путем вызова IErrorInfo::GetDescription, который задает значение NULL, если языковой стандарт не поддерживается, или если оба из следующих условий имеют значение true:
Значение lcid не является американским английским и
Значение lcid не равно значению, возвращаемого GetUserDefaultLCID.
CDBErrorInfo::GetBasicErrorInfo
Вызывает IErrorRecords::GetBasicErrorInfo для возврата основных сведений об ошибке, таких как код возврата и номер ошибки для конкретного поставщика.
Синтаксис
HRESULT GetBasicErrorInfo(ULONG ulRecordNum,
ERRORINFO* pErrorInfo) const throw();
Параметры
См. статью IErrorRecords::GetBasicErrorInfo в справочнике программиста OLE DB.
Возвращаемое значение
Стандартный HRESULT.
CDBErrorInfo::GetCustomErrorObject
Вызывает IErrorRecords::GetCustomErrorObject , чтобы вернуть указатель на интерфейс для пользовательского объекта ошибки.
Синтаксис
HRESULT GetCustomErrorObject(ULONG ulRecordNum,
REFIID riid,IUnknown** ppObject) const throw();
Параметры
См. раздел IErrorRecords::GetCustomErrorObject в справочнике программиста OLE DB.
Возвращаемое значение
Стандартный HRESULT.
CDBErrorInfo::GetErrorInfo
Вызывает IErrorRecords::GetErrorInfo, чтобы вернуть указатель интерфейса IErrorInfo на указанную запись.
Синтаксис
HRESULT GetErrorInfo(ULONG ulRecordNum,
LCID lcid,IErrorInfo** ppErrorInfo) const throw();
Параметры
См. раздел IErrorRecords::GetErrorInfo в справочнике программиста OLE DB.
Возвращаемое значение
Стандартный HRESULT.
CDBErrorInfo::GetErrorParameters
Вызывает IErrorRecords::GetErrorParameters , чтобы вернуть параметры ошибки.
Синтаксис
HRESULT GetErrorParameters(ULONG ulRecordNum,
DISPPARAMS* pdispparams) const throw();
Параметры
См. раздел IErrorRecords::GetErrorParameters в справочнике программиста OLE DB.
Возвращаемое значение
Стандартный HRESULT.
CDBErrorInfo::GetErrorRecords
Возвращает записи об ошибках для указанного объекта.
Синтаксис
HRESULT GetErrorRecords(IUnknown* pUnk,
const IID& iid,
ULONG* pcRecords) throw();
HRESULT GetErrorRecords(ULONG* pcRecords) throw();
Параметры
панк
[in] Интерфейс к объекту, для которого необходимо получить записи об ошибках.
iid
[in] IID интерфейса, связанного с ошибкой.
pcRecords
[out] Указатель на число записей ошибок (на основе одного).
Возвращаемое значение
Стандартный HRESULT.
Замечания
Используйте первую форму функции, если вы хотите проверить, какой интерфейс будет получать сведения об ошибке. В противном случае используйте вторую форму.
См. также
DBViewer
Шаблоны объекта-получателя OLE DB
Ссылка на шаблоны объекта-получателя OLE DB