IBackgroundCopyManager::GetErrorDescription-Methode (bits.h)

Ruft eine Beschreibung für den angegebenen Fehlercode ab.

Syntax

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

Die Parameter

[in] hResult

Fehlercode aus einem vorherigen Aufruf einer BITS-Methode.

[in] LanguageId

Gibt den Sprachbezeichner an, der zum Generieren der Beschreibung verwendet werden soll. Verwenden Sie das MAKELANGID-Makro , um den Sprachbezeichner zu erstellen. Verwenden Sie z. B. das folgende Codebeispiel, um US-Englisch anzugeben.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Verwenden Sie die folgenden Aufrufe, um den Standardbenutzersprachenbezeichner des Systems abzurufen.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

Null-beendete Zeichenfolge, die eine Beschreibung des Fehlers enthält. Rufen Sie die CoTaskMemFree-Funktion auf, um ppErrorDescription frei zu geben, wenn Sie fertig sind.

Rückgabewert

Diese Methode gibt die folgenden HRESULT-Werte sowie andere zurück.

Bemerkungen

Beschreibungen für HTTP-Fehler werden lokalisiert.

Windows XP/2000: Beschreibungen für HTTP-Fehler werden nicht lokalisiert.

Examples

Das folgende Beispiel zeigt, wie Sie die Beschreibung abrufen, die einem Fehlercode zugeordnet ist. Die g_XferManager Variable im Beispiel ist ein IBackgroundCopyManager-Schnittstellenzeiger . Ausführliche Informationen zum Erstellen des IBackgroundCopyManager-Schnittstellenzeigers finden Sie unter Herstellen einer Verbindung mit dem BITS-Dienst.

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);
  }
}

Anforderungen

Siehe auch

Behandeln von Fehlern

IBackgroundCopyError

IBackgroundCopyJob::GetError