Funzione WsSetFaultErrorDetail (webservices.h)

Articolo
03/03/2024

Scrivere i dettagli di errore archiviati in un oggetto WS_ERROR .

Sintassi

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

Parametri

[in] error

Oggetto errore che conterrà le informazioni di errore.

[in] faultDetailDescription

Puntatore a una descrizione dei dettagli dell'errore.

Se il campo azione della descrizione dei dettagli di errore non è NULL, viene impostato come WS_FAULT_ERROR_PROPERTY_ACTION dell'WS_ERROR.

La descrizione dell'elemento della descrizione dei dettagli di errore descrive il formato dell'elemento nel dettaglio dell'errore.

[in] writeOption

Informazioni sulla modalità di allocazione del valore. Per altre informazioni , vedere WS_WRITE_OPTION .

value

Puntatore al valore da serializzare.

[in] valueSize

Dimensioni del valore serializzato, in byte.

Se il valore è NULL, le dimensioni devono essere 0.

Valore restituito

Questa funzione può restituire uno di questi valori.

Codice restituito	Descrizione
WS_E_INVALID_FORMAT	I dati di input non erano nel formato previsto o non hanno il valore previsto.
E_INVALIDARG	Uno o più argomenti non sono validi.
E_OUTOFMEMORY	Memoria insufficiente.

Commenti

Questa API serializzerà il valore del campo dettaglio dell'WS_FAULT archiviato nell'oggetto WS_ERROR .

Queste funzioni supportano gli scenari seguenti, in base al contenuto della WS_ELEMENT_DESCRIPTION nella WS_FAULT_DETAIL_DESCRIPTION fornita:

Scrittura di un singolo elemento. In questo caso, i campi elementLocalName e elementNs del WS_ELEMENT_DESCRIPTION devono essere impostati sul nome locale e sullo spazio dei nomi dell'elemento da scrivere e il tipo e la descrizione del tipo rappresenta il tipo del valore serializzato.
Scrittura di più elementi come singolo valore. In questo caso, i campi elementLocalName e elementNs del WS_ELEMENT_DESCRIPTION devono essere impostati su NULL e deve essere specificato un WS_STRUCT_TYPE e un WS_STRUCT_DESCRIPTION. Ogni campo del valore della struttura serializzato deve corrispondere agli elementi da scrivere all'interno del dettaglio dell'errore. Il parametro writeOption deve essere WS_WRITE_REQUIRED_VALUE o WS_WRITE_REQUIRED_POINTER.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2008 R2 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	webservices.h
Libreria	WebServices.lib
DLL	WebServices.dll

Condividi tramite