IBackgroundCopyManager：：GetErrorDescription 方法 (bits.h)

擷取指定之錯誤碼的描述。

語法

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

參數

[in] hResult

先前呼叫 BITS 方法的錯誤碼。

[in] LanguageId

識別要用來產生描述的語言標識碼。 若要建立語言標識碼，請使用 MAKELANGID 宏。 例如，若要指定美式英文，請使用下列程式代碼範例。

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

若要擷取系統的默認使用者語言標識碼，請使用下列呼叫。

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

包含錯誤描述的 Null 終止字串。 完成時呼叫 CoTaskMemFree 函式以釋放 ppErrorDescription 。

傳回值

這個方法會傳回下列 HRESULT 值，以及其他值。

傳回碼	Description
S_OK	已成功擷取錯誤碼描述。
HRESULT_FROM_WIN32 (ERROR_RESOURCE_LANG_NOT_FOUND)	地區設定沒有可用的字串。

備註

HTTP 錯誤的描述已當地語系化。

Windows XP/2000： 不會本地化 HTTP 錯誤的描述。

範例

下列範例示範如何擷取與錯誤碼相關聯的描述。 範例中的g_XferManager變數是 IBackgroundCopyManager 介面指標。 如需建立 IBackgroundCopyManager 介面指標的詳細資訊，請參閱 連線到BITS服務。

HRESULT hr = 0;
IBackgroundCopyJob* pJob = NULL;
WCHAR* pszDescription = NULL;

//Call fails because the third parameter is NULL.
hr = g_XferManager->CreateJob(L"DummyJob", BG_JOB_TYPE_DOWNLOAD, NULL, &pJob);
if (FAILED(hr))
{
  hr = g_XferManager->GetErrorDescription(hr, LANGIDFROMLCID(GetThreadLocale()), &pszDescription);
  if (SUCCEEDED(hr))
  {
    //Do something with pszDescription.
    CoTaskMemFree(pszDescription);
  }
}

規格需求

需求	值
最低支援的用戶端	Windows XP
最低支援的伺服器	Windows Server 2003
目標平台	Windows
標頭	bits.h
程式庫	Bits.lib
Dll	QmgrPrxy.dll

另請參閱

處理錯誤

IBackgroundCopyError

IBackgroundCopyJob：：GetError