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] 錯誤的說明主題內容識別碼指標。
pbstrHelpFile
[out] 包含描述錯誤說明檔路徑之字串的指標。
傳回值
如果成功,S_OK。 如需其他傳回值,請參閱 OLE DB 程式設計人員參考中的 IErrorRecords::GetErrorInfo。
備註
pbstrDescription 的輸出值是透過呼叫 IErrorInfo::GetDescription
在內部取得,如果不支援地區設定,或下列兩個條件都成立,則會將值設定為 NULL:
lcid 的值不是美國英文和
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();
參數
朋克
[in]要取得錯誤記錄的物件介面。
iid
[in]與錯誤相關聯之介面的 IID。
pcRecords
[out]錯誤記錄計數的指標。
傳回值
標準 HRESULT。
備註
如果您想要檢查要從哪個介面取得錯誤資訊,請使用函式的第一種形式。 否則,請使用第二個窗體。