Método IBackgroundCopyManager::GetErrorDescription (bits.h)

Recupera una descripción del código de error especificado.

Syntax

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

Parámetros

[in] hResult

Código de error de una llamada anterior a un método BITS.

[in] LanguageId

Identifica el identificador de idioma que se va a usar para generar la descripción. Para crear el identificador de lenguaje, use la macro MAKELANGID . Por ejemplo, para especificar inglés de EE. UU., use el ejemplo de código siguiente.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Para recuperar el identificador de idioma de usuario predeterminado del sistema, use las siguientes llamadas.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

Cadena terminada en NULL que contiene una descripción del error. Llame a la función CoTaskMemFree para liberar ppErrorDescription cuando haya terminado.

Valor devuelto

Este método devuelve los siguientes valores HRESULT , así como otros.

Código de retorno	Description
S_OK	Se recuperó correctamente la descripción del código de error.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)	No hay ninguna cadena disponible para la configuración regional.

Observaciones

Las descripciones de los errores HTTP se localizan.

Windows XP/2000: Las descripciones de los errores HTTP no se localizan.

Examples

En el ejemplo siguiente se muestra cómo recuperar la descripción asociada a un código de error. La variable g_XferManager del ejemplo es un puntero de interfaz IBackgroundCopyManager . Para obtener más información sobre cómo crear el puntero de interfaz IBackgroundCopyManager , consulte Conexión al servicio 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);
  }
}

Requisitos

Requirement	Importancia
Cliente mínimo compatible	Windows XP
Servidor mínimo admitido	Windows Server 2003
de la plataforma de destino de	Windows
Header	bits.h
Library	Bits.lib
DLL de	QmgrPrxy.dll

Consulte también

Control de errores

IBackgroundCopyError

IBackgroundCopyJob::GetError