Compartilhar via


Função WsGetErrorString (webservices.h)

Recupera uma cadeia de caracteres de erro de um objeto de erro.

Sintaxe

HRESULT WsGetErrorString(
  [in]  WS_ERROR  *error,
  [in]  ULONG     index,
  [out] WS_STRING *string
);

Parâmetros

[in] error

O objeto de erro que contém a cadeia de caracteres.

[in] index

O índice baseado em zero que identifica a cadeia de caracteres a ser recuperada. A primeira cadeia de caracteres de erro (índice 0) será a cadeia de caracteres adicionada mais recentemente ao objeto de erro (usando WsAddErrorString). Quando WS_ERROR_PROPERTY_ORIGINAL_ERROR_CODE for apresentado no objeto de erro, o texto de erro correspondente estará disponível no último índice.

O número de erros pode ser recuperado usando WS_ERROR_PROPERTY_STRING_COUNT.

[out] string

A cadeia de caracteres retornada. A cadeia de caracteres é válida até que WsResetError ou WsFreeError seja chamado.

A cadeia de caracteres não é terminada em zero.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno Descrição
E_INVALIDARG
Um ou mais argumentos são inválidos.
Outros erros
Essa função pode retornar outros erros não listados acima.

Comentários

A cadeia de caracteres está no idioma especificado pela propriedade LANGID do objeto error. Isso pode ser recuperado usando WsGetErrorProperty com WS_ERROR_PROPERTY_LANGID.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 7 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 R2 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho webservices.h
Biblioteca WebServices.lib
DLL WebServices.dll