Metode IBackgroundCopyManager::GetErrorDescription (bits.h)

Mengambil deskripsi untuk kode kesalahan yang ditentukan.

Sintaks

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

Parameter

[in] hResult

Kode kesalahan dari panggilan sebelumnya ke metode BITS.

[in] LanguageId

Mengidentifikasi pengidentifikasi bahasa yang akan digunakan untuk menghasilkan deskripsi. Untuk membuat pengidentifikasi bahasa, gunakan makro MAKELANGID . Misalnya, untuk menentukan bahasa Inggris AS, gunakan sampel kode berikut.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Untuk mengambil pengidentifikasi bahasa pengguna default sistem, gunakan panggilan berikut.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

String yang dihentikan null yang berisi deskripsi kesalahan. Panggil fungsi CoTaskMemFree untuk membebaskan ppErrorDescription setelah selesai.

Menampilkan nilai

Metode ini mengembalikan nilai HRESULT berikut, serta yang lain.

Menampilkan kode Deskripsi
S_OK
Deskripsi kode kesalahan berhasil diambil.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)
Tidak ada string yang tersedia untuk lokal.

Keterangan

Deskripsi untuk kesalahan HTTP dilokalkan.

Windows XP/2000: Deskripsi untuk kesalahan HTTP tidak dilokalkan.

Contoh

Contoh berikut menunjukkan cara mengambil deskripsi yang terkait dengan kode kesalahan. Variabel g_XferManager dalam contoh adalah penunjuk antarmuka IBackgroundCopyManager . Untuk detail tentang membuat penunjuk antarmuka IBackgroundCopyManager , lihat Menyambungkan ke Layanan 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);
  }
}

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows XP
Server minimum yang didukung Windows Server 2003
Target Platform Windows
Header bits.h
Pustaka Bits.lib
DLL QmgrPrxy.dll

Lihat juga

Menangani Kesalahan

IBackgroundCopyError

IBackgroundCopyJob::GetError