Win32 API 日本語リファレンス
ホーム › System.Com › IErrorInfo

IErrorInfo

COM
📘 Microsoft Learn (日本語) · English
IID1cf2b120-547d-101b-8e65-08002b2bd119継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

詳細な文脈依存のエラー情報を提供します。

メソッド 5

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetGUID(GUID* pGUID)

エラーを定義したインターフェイスのグローバル一意識別子 (GUID) を返します。

pGUIDGUID*outGUID へのポインター。エラーがオペレーティングシステムによって定義された場合は GUID_NULL。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

IErrorInfo::GetGUID は、エラーを定義したインターフェイスの GUID を返します。エラーがシステムによって定義された場合、IErrorInfo::GetGUID は GUID_NULL を返します。

この GUID は必ずしもエラーの発生源を表すものではありません。発生源は、エラーを発生させたクラスまたはアプリケーションです。この GUID を使用することで、アプリケーションはインターフェイスを実装するクラスに依存せず、そのインターフェイスにおけるエラーを処理できます。

vtbl 4 HRESULT GetSource(LPWSTR* pBstrSource)

エラーを発生させたクラスまたはアプリケーションの、言語依存のプログラム識別子 (ProgID) を返します。

pBstrSourceLPWSTR*outprogname.objectname の形式の ProgID。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

エラーの発生源であるクラスまたはアプリケーションを特定するには、IErrorInfo::GetSource を使用します。返される ProgID の言語は、呼び出し時にメソッドへ渡されたロケール ID (LCID) に依存します。

vtbl 5 HRESULT GetDescription(LPWSTR* pBstrDescription)

エラーのテキストによる説明を返します。

pBstrDescriptionLPWSTR*outエラーの簡潔な説明。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

テキストは、エラーが発生したメソッドに対して IDispatch::Invoke へ渡されたロケール識別子 (LCID) で指定された言語で返されます。

vtbl 6 HRESULT GetHelpFile(LPWSTR* pBstrHelpFile)

エラーを説明するヘルプファイルのパスを返します。

pBstrHelpFileLPWSTR*outヘルプファイルの完全修飾パス。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、現在のエラーを説明するヘルプファイルの完全修飾パスを返します。ヘルプファイル内でエラーに対応するヘルプコンテキスト ID を検索するには、IErrorInfo::GetHelpContext を使用してください。

vtbl 7 HRESULT GetHelpContext(DWORD* pdwHelpContext)

エラーのヘルプコンテキスト識別子 (ID) を返します。

pdwHelpContextDWORD*outエラーのヘルプコンテキスト ID。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、エラーのヘルプコンテキスト ID を返します。それが適用されるヘルプファイルを特定するには、IErrorInfo::GetHelpFile を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IErrorInfo "{1CF2B120-547D-101B-8E65-08002B2BD119}"
#usecom global IErrorInfo IID_IErrorInfo "{}"
#comfunc global IErrorInfo_GetGUID         3 var
#comfunc global IErrorInfo_GetSource       4 var
#comfunc global IErrorInfo_GetDescription  5 var
#comfunc global IErrorInfo_GetHelpFile     6 var
#comfunc global IErrorInfo_GetHelpContext  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。