取得指定錯誤碼的描述。
語法
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
包含錯誤描述的空終止字串。 完成後呼叫 CoTaskMemFree 函式來釋放 ppErrorDescription 。
返回值
此方法回傳以下 HRESULT 值及其他值。
| 回傳碼 | Description |
|---|---|
|
錯誤代碼描述已成功取得。 |
|
該地點沒有條件。 |
備註
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);
}
}
需求
| Requirement | 價值觀 |
|---|---|
| 最低支援的用戶端 | 視窗XP |
| 支援的最低伺服器 | Windows Server 2003 |
| 目標平臺 | 窗戶 |
| Header | Bits.h |
| Library | Bits.lib |
| DLL | QmgrPrxy.dll |