IBackgroundCopyError::GetErrorContextDescription メソッド (bits.h)

エラーが発生したコンテキストの説明を取得します。

構文

HRESULT GetErrorContextDescription(
  [in]  DWORD  LanguageId,
  [out] LPWSTR *pContextDescription
);

[in] LanguageId

説明の生成に使用するロケールを識別します。言語識別子を作成するには、 MAKELANGID マクロを使用します。たとえば、米国英語を指定するには、次のコードサンプルを使用します。

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

システムの既定のユーザー言語識別子を取得するには、次の呼び出しを使用します。

LANGIDFROMLCID(GetThreadLocale())

[out] pContextDescription

エラーが発生したコンテキストの説明を含む Null で終わる文字列。完了したら、 CoTaskMemFree 関数を呼び出して ppContextDescription を解放します。

このメソッドは、次の HRESULT 値と他の値を返します。

リターンコード	説明
S_OK	コンテキストの説明が正常に取得されました。
E_OUTOFMEMORY	メモリ不足のため、操作を完了できません。
E_INVALIDARG	LanguageId パラメーターを 0 にすることはできません。
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)	ロケールに使用できる文字列はありません。