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
);
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 zum Erstellen des Sprachbezeichners das MAKELANGID-Makro . Verwenden Sie beispielsweise das folgende Codebeispiel, um US-Englisch anzugeben.
MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)
Verwenden Sie die folgenden Aufrufe, um den Standardbenutzersprachbezeichner 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 machen, wenn Sie fertig sind.
Rückgabewert
Diese Methode gibt die folgenden HRESULT-Werte sowie andere zurück.
| Rückgabecode | Beschreibung |
|---|---|
|
Die Fehlercodebeschreibung wurde erfolgreich abgerufen. |
|
Für das Gebietsschema ist keine Zeichenfolge verfügbar. |
Hinweise
Beschreibungen für HTTP-Fehler werden lokalisiert.
Windows XP/2000: Beschreibungen für HTTP-Fehler sind nicht lokalisiert.
Beispiele
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
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows XP |
| Unterstützte Mindestversion (Server) | Windows Server 2003 |
| Zielplattform | Windows |
| Kopfzeile | bits.h |
| Bibliothek | Bits.lib |
| DLL | QmgrPrxy.dll |