次の方法で共有

CDBErrorInfo クラス

  • [アーティクル]

OLE DB IErrorRecords インターフェイスを使用して OLE DB エラー処理のサポートを提供します。

構文

class CDBErrorInfo

要件

ヘッダー: atldbcli.h

メンバー

メソッド

Name 説明
GetAllErrorInfo エラー レコードに含まれるすべてのエラー情報を返します。
GetBasicErrorInfo IErrorRecords::GetBasicErrorInfo を呼び出して、指定されたエラーに関する基本情報を返します。
GetCustomErrorObject IErrorRecords::GetCustomErrorObject を呼び出して、カスタム エラー オブジェクトのインターフェイスへのポインターを返します。
GetErrorInfo IErrorRecords::GetErrorInfo を呼び出して、指定されたレコードへの IErrorInfo インターフェイス ポインターを返します。
GetErrorParameters IErrorRecords::GetErrorParameters を呼び出して、エラー パラメーターを返します。
GetErrorRecords 指定されたオブジェクトのエラー レコードを取得します。

解説

このインターフェイスは、1 つ以上のエラー レコードをユーザーに返します。 最初に 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
[入力] エラー情報を返すレコードの、0 から始る番号。

lcid
[入力] 返されるエラー情報のロケール ID。

pbstrDescription
[出力] エラーのテキスト説明へのポインター。ロケールがサポートされていない場合は NULL。 「解説」を参照してください。

pbstrSource
[出力] エラーを生成したコンポーネントの名前を含んだ文字列へのポインター。

pguid
[出力] エラーを定義したインターフェイスの GUID へのポインター。

pdwHelpContext
[出力] エラーのヘルプ コンテキスト ID へのポインター。

pbstrHelpFile
[出力] エラーを説明するヘルプ ファイルへのパスを含んだ文字列へのポインター。

戻り値

成功した場合は、S_OK。 その他の戻り値については、"OLE DB プログラマーズ リファレンス" の「IErrorRecords::GetErrorInfo」をご覧ください。

解説

pbstrDescription の出力値は、IErrorInfo::GetDescription を呼び出すことによって内部的に取得されます。ロケールがサポートされていない場合、または次の両方の条件に当てはまる場合は、値が NULL に設定されます。

  1. lcid の値が米国英語ではなく、

  2. 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();

パラメーター

pUnk
[入力] エラー レコードを取得するオブジェクトへのインターフェイス。

iid
[入力] エラーに関連付けられているインターフェイスの IID。

pcRecords
[出力] エラー レコードの (1 から始まる) カウントへのポインター。

戻り値

標準の HRESULT。

解説

どのインターフェイスからエラー情報を取得するかを確認したい場合は、関数の 1 つ目の形式を使用してください。 それ以外の場合は、2 つ目の形式を使用してください。

関連項目

DBViewer
OLE DB コンシューマー テンプレートに関するページ
OLE DB コンシューマー テンプレート リファレンス