IErrorRecordsImpl クラス
CAtlArray<RecordClass> 型のデータ メンバー (m_rgErrors) のレコードを追加および取得する OLE DB の IErrorRecords インターフェイスを実装します。
構文
template <class T, class RecordClass = ATLERRORINFO>
class IErrorRecordsImpl : public IErrorRecords
パラメーター
T
IErrorRecordsImpl の派生クラス。
RecordClass
OLE DB のエラー オブジェクトを表すクラス。
要件
ヘッダー: atldb.h
メンバー
メソッド
| Name | 説明 |
|---|---|
| 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;