CComCoClass::Error

2011-08-09

この静的関数は、IErrorInfo インターフェイスをセットアップして、クライアントにエラー情報を提供します。

static HRESULT WINAPI Error(
   LPCOLESTR lpszDesc,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   LPCOLESTR lpszDesc,
   DWORD dwHelpID,
   LPCOLESTR lpszHelpFile,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   LPCSTR lpszDesc,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   LPCSTR lpszDesc,
   DWORD dwHelpID,
   LPCSTR lpszHelpFile,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   UINT nID,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0,
   HINSTANCE hInst = _AtlBaseModule.GetResourceInstance ()
);
static HRESULT Error(
   UINT nID,
   DWORD dwHelpID,
   LPCOLESTR lpszHelpFile,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0,
   HINSTANCE hInst = _AtlBaseModule.GetResourceInstance() 
);

パラメーター

lpszDesc
[入力] エラーを説明する文字列。 Error の Unicode バージョンでは lpszDesc は LPCOLESTR 型にします。ANSI バージョンでは LPCSTR 型にします。
iid
[入力] エラーを定義するインターフェイスの IID または GUID_NULL (既定値)。エラーはオペレーティングシステムによって定義されます。
hRes
[入力] 呼び出し側に返す HRESULT。既定値は 0 です。 hRes の詳細については、「解説」を参照してください。
nID
[入力] エラーを説明する文字列を格納するリソースの識別子。この値は、0x0200 から 0xFFFF までの間にする必要があります。 nID が有効な文字列を指していない場合、デバッグビルドでは ASSERT が発生します。リリースビルドでは、エラーを説明する文字列が "Unknown Error" に設定されます。
dwHelpID
[入力] エラーに対するヘルプコンテキストの識別子。
lpszHelpFile
[入力] エラーを説明するヘルプファイルのパスと名前。
hInst
[入力] リソースへのハンドル。既定では、このパラメーターは _AtlModule::GetResourceInstance になります。_AtlModule は CAtlModule のグローバルなインスタンスです。

戻り値

標準の HRESULT 値を返します。詳細については、「解説」を参照してください。

解説

Error を呼び出すには、オブジェクトに ISupportErrorInfo Interface インターフェイスが実装されている必要があります。

hRes パラメーターが 0 でない場合は、Error は hRes の値を返します。 hRes が 0 の場合は、Error の最初の 4 つのバージョンは DISP_E_EXCEPTION を返します。最後の 2 つのバージョンは MAKE_HRESULT( 1, FACILITY_ITF, nID ) マクロの結果を返します。