ホーム › System.WindowsSync › IRecoverableErrorData

IRecoverableErrorData

COM

IIDb37c4a0a-4b7d-4c2d-9711-3b00d119b1c8継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

回復可能なエラーに関する情報を表します。

解説(Remarks)

このインターフェイスでサポートされていない追加情報を伝達するには、IRecoverableErrorData とカスタムインターフェイスの両方を継承するオブジェクトを実装します。アプリケーションが ISyncCallback::OnRecoverableError メソッドで IRecoverableErrorData オブジェクトを受け取ったとき、そのオブジェクトに対して QueryInterface を呼び出すことで、カスタムインターフェイスを取得できます。

メソッド 3

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

vtbl 3 HRESULT Initialize(LPWSTR pcszItemDisplayName, LPWSTR pcszErrorDescription)

エラーの原因となったアイテムの表示名と、エラーの説明を指定してオブジェクトを初期化します。

pcszItemDisplayName	LPWSTR	in	エラーの原因となったアイテムの表示名。
pcszErrorDescription	LPWSTR	in	エラーの説明。

戻り値

戻り値には、次の表に示す値が含まれます (これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY
プロバイダーが定めるエラーコード。

vtbl 4 HRESULT GetItemDisplayName(LPWSTR pszItemDisplayName, DWORD* pcchItemDisplayName)

エラーの原因となったアイテムの表示名を取得します。

pszItemDisplayName	LPWSTR	in	エラーの原因となったアイテムの表示名を返します。
pcchItemDisplayName	DWORD*	inout	pszItemDisplayName の文字数を指定します。pcchItemDisplayName が小さすぎる場合は pszItemDisplayName に必要な文字数を返し、それ以外の場合は書き込まれた文字数を返します。

戻り値

戻り値には、次の表に示す値が含まれます (これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pszItemDisplayName が小さすぎます。この場合、必要な文字数が pcchItemDisplayName に返されます。
プロバイダーが定めるエラーコード。

vtbl 5 HRESULT GetErrorDescription(LPWSTR pszErrorDescription, DWORD* pcchErrorDescription)

エラーの説明を取得します。

pszErrorDescription	LPWSTR	in	エラーの説明を返します。
pcchErrorDescription	DWORD*	inout	pszErrorDescription の文字数を指定します。pcchErrorDescription が小さすぎる場合は pszErrorDescription に必要な文字数を返し、それ以外の場合は書き込まれた文字数を返します。

戻り値

戻り値には、次の表に示す値が含まれます (これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pszErrorDescription が小さすぎます。この場合、必要な文字数が pcchErrorDescription に返されます。
プロバイダーが定めるエラーコード。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRecoverableErrorData "{B37C4A0A-4B7D-4C2D-9711-3B00D119B1C8}"
#usecom global IRecoverableErrorData IID_IRecoverableErrorData "{}"
#comfunc global IRecoverableErrorData_Initialize           3 wstr,wstr
#comfunc global IRecoverableErrorData_GetItemDisplayName   4 wstr,var
#comfunc global IRecoverableErrorData_GetErrorDescription  5 wstr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IRecoverableErrorData "{B37C4A0A-4B7D-4C2D-9711-3B00D119B1C8}"
#usecom global IRecoverableErrorData IID_IRecoverableErrorData "{}"
#comfunc global IRecoverableErrorData_Initialize           3 wstr,wstr
#comfunc global IRecoverableErrorData_GetItemDisplayName   4 wstr,sptr
#comfunc global IRecoverableErrorData_GetErrorDescription  5 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。