Compartilhar via


Função WsSetFaultErrorDetail (webservices.h)

Escreva os detalhes de falha armazenados em um objeto WS_ERROR .

Sintaxe

HRESULT WsSetFaultErrorDetail(
  [in] WS_ERROR                          *error,
  [in] const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
  [in] WS_WRITE_OPTION                   writeOption,
       const void                        *value,
  [in] ULONG                             valueSize
);

Parâmetros

[in] error

O objeto de erro que conterá as informações de falha.

[in] faultDetailDescription

Um ponteiro para uma descrição dos detalhes da falha.

Se o campo de ação da descrição de detalhes da falha não for NULL, ele será definido como o WS_FAULT_ERROR_PROPERTY_ACTION do WS_ERROR.

A descrição do elemento da descrição de detalhes da falha descreve o formato do elemento nos detalhes da falha.

[in] writeOption

Informações sobre como o valor é alocado. Consulte WS_WRITE_OPTION para obter mais informações.

value

Um ponteiro para o valor a ser serializado.

[in] valueSize

O tamanho do valor que está sendo serializado, em bytes.

Se o valor for NULL, o tamanho deverá ser 0.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno Descrição
WS_E_INVALID_FORMAT
Os dados de entrada não estavam no formato esperado ou não tinham o valor esperado.
E_INVALIDARG
Um ou mais argumentos são inválidos.
E_OUTOFMEMORY
Ficou sem memória.

Comentários

Essa API serializará o valor do campo de detalhes do WS_FAULT armazenado no objeto WS_ERROR .

Essas funções dão suporte aos seguintes cenários, com base no conteúdo do WS_ELEMENT_DESCRIPTION no WS_FAULT_DETAIL_DESCRIPTION fornecido:

  • Gravando um único elemento. Nesse caso, os campos elementLocalName e elementNs do WS_ELEMENT_DESCRIPTION devem ser definidos como o nome local e o namespace do elemento a ser gravado, e o tipo e a descrição do tipo representam o tipo do valor que está sendo serializado.
  • Gravando vários elementos como um único valor. Nesse caso, os campos elementLocalName e elementNs do WS_ELEMENT_DESCRIPTION devem ser definidos como NULL e um WS_STRUCT_TYPE e WS_STRUCT_DESCRIPTION devem ser especificados. Cada campo do valor da estrutura que está sendo serializado deve corresponder aos elementos a serem gravados nos detalhes da falha. O parâmetro writeOption deve ser WS_WRITE_REQUIRED_VALUE ou WS_WRITE_REQUIRED_POINTER.

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