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

  • Artigo

Recupera o texto de erro associado ao erro.

Sintaxe

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

Parâmetros

[in] LanguageId

Identifica a localidade a ser usada para gerar a descrição. Para criar o identificador de idioma, use a macro MAKELANGID . Por exemplo, para especificar o inglês dos EUA, 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 o texto de erro associado ao 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 erro foi recuperada com êxito.
E_OUTOFMEMORY
 Não há memória disponível suficiente para concluir a operação.
E_INVALIDARG
 O parâmetro LanguageId não pode ser 0.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)
 Nenhuma cadeia de caracteres está disponível para a localidade.

Comentários

Você também pode chamar o método IBackgroundCopyManager::GetErrorDescription para recuperar o texto de erro associado a um código de erro.

Descrições para erros HTTP são localizadas.

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

Exemplos

Consulte o código de exemplo no tópico Tratamento de Erros .

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

IBackgroundCopyError::GetError

IBackgroundCopyError::GetErrorContextDescription

IBackgroundCopyError::GetFile

IBackgroundCopyManager::GetErrorDescription