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

Recupera uma descrição para o código de erro especificado.

Sintaxe

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

Parâmetros

[in] hResult

Código de erro de uma chamada anterior para um método BITS.

[in] LanguageId

Identifica o identificador de idioma a ser usado para gerar a descrição. Para criar o identificador de linguagem, use a macro MAKELANGID . Por exemplo, para especificar inglês americano, use o exemplo de código a seguir.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Para recuperar o identificador de idioma de usuário padrão do sistema, use as chamadas a seguir.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

Cadeia de caracteres terminada em nulo que contém uma descrição do erro. Chame a função CoTaskMemFree para liberar ppErrorDescription quando terminar.

Retornar valor

Esse método retorna os seguintes valores HRESULT , bem como outros.

Código de retorno	Descrição
S_OK	A descrição do código de erro foi recuperada com êxito.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)	Nenhuma cadeia de caracteres está disponível para a localidade.

Comentários

As descrições de erros HTTP são localizadas.

Windows XP/2000: As descrições de erros HTTP não são localizadas.

Exemplos

O exemplo a seguir mostra como recuperar a descrição associada a um código de erro. A variável g_XferManager no exemplo é um ponteiro de interface IBackgroundCopyManager . Para obter detalhes sobre como criar o ponteiro da interface IBackgroundCopyManager , consulte Conectando-se ao serviço 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

Requisito	Valor
Cliente mínimo com suporte	Windows XP
Servidor mínimo com suporte	Windows Server 2003
Plataforma de Destino	Windows
Cabeçalho	bits.h
Biblioteca	Bits.lib
DLL	QmgrPrxy.dll

Confira também

Tratando erros

IBackgroundCopyError

IBackgroundCopyJob::GetError