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

エラーに関連付けられているエラー テキストを取得します。

構文

HRESULT GetErrorDescription(
  [in]  DWORD  LanguageId,
  [out] LPWSTR *pErrorDescription
);

パラメーター

[in] LanguageId

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

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

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

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

エラーに関連付けられたエラー テキストを含む Null で終わる文字列。 完了したら、 CoTaskMemFree 関数を呼び出して ppErrorDescription を解放します。

戻り値

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

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

注釈

IBackgroundCopyManager::GetErrorDescription メソッドを呼び出して、エラー コードに関連付けられているエラー テキストを取得することもできます。

HTTP エラーの説明はローカライズされています。

Windows XP/2000: HTTP エラーの説明はローカライズされません。

「エラーの処理」トピックのコード例を参照してください。

要件

要件
サポートされている最小のクライアント Windows XP
サポートされている最小のサーバー Windows Server 2003
対象プラットフォーム Windows
ヘッダー bits.h
Library Bits.lib
[DLL] QmgrPrxy.dll

こちらもご覧ください

IBackgroundCopyError::GetError

IBackgroundCopyError::GetErrorContextDescription

IBackgroundCopyError::GetFile

IBackgroundCopyManager::GetErrorDescription