Metodo IBackgroundCopyManager::GetErrorDescription (bits.h)

Recupera una descrizione per il codice di errore specificato.

Sintassi

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

Parametri

[in] hResult

Codice di errore da una chiamata precedente a un metodo BITS.

[in] LanguageId

Identifica l'identificatore di lingua da utilizzare per generare la descrizione. Per creare l'identificatore di lingua, utilizzare la macro MAKELANGID . Ad esempio, per specificare l'inglese degli Stati Uniti, usare l'esempio di codice seguente.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Per recuperare l'identificatore di lingua utente predefinito del sistema, usare le chiamate seguenti.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

Stringa con terminazione Null contenente una descrizione dell'errore. Chiamare la funzione CoTaskMemFree per liberare ppErrorDescription al termine.

Valore restituito

Questo metodo restituisce i valori HRESULT seguenti, nonché altri.

Codice restituito	Descrizione
S_OK	La descrizione del codice di errore è stata recuperata correttamente.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)	Nessuna stringa è disponibile per le impostazioni locali.

Commenti

Le descrizioni per gli errori HTTP vengono localizzate.

Windows XP/2000: Le descrizioni per gli errori HTTP non vengono localizzate.

Esempio

Nell'esempio seguente viene illustrato come recuperare la descrizione associata a un codice di errore. La variabile g_XferManager nell'esempio è un puntatore all'interfaccia IBackgroundCopyManager . Per informazioni dettagliate sulla creazione del puntatore all'interfaccia IBackgroundCopyManager , vedere Connessione al servizio 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);
  }
}

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP
Server minimo supportato	Windows Server 2003
Piattaforma di destinazione	Windows
Intestazione	bits.h
Libreria	Bits.lib
DLL	QmgrPrxy.dll

Vedi anche

Gestione degli errori

IBackgroundCopyError

IBackgroundCopyJob::GetError