WsSetFaultErrorDetail, fonction (webservices.h)

Article
08/27/2023

Écrivez le détail de l’erreur stocké dans un objet WS_ERROR .

Syntaxe

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

Paramètres

[in] error

Objet d’erreur qui contiendra les informations d’erreur.

[in] faultDetailDescription

Pointeur vers une description du détail de l’erreur.

Si le champ d’action de la description des détails de l’erreur n’est pas NULL, il est défini comme WS_FAULT_ERROR_PROPERTY_ACTION de l’WS_ERROR.

La description de l’élément de la description des détails de l’erreur décrit le format de l’élément dans le détail de l’erreur.

[in] writeOption

Informations sur la façon dont la valeur est allouée. Pour plus d’informations, consultez WS_WRITE_OPTION .

value

Pointeur vers la valeur à sérialiser.

[in] valueSize

Taille de la valeur sérialisée, en octets.

Si la valeur est NULL, la taille doit être 0.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
WS_E_INVALID_FORMAT	Les données d’entrée n’étaient pas au format attendu ou n’avaient pas la valeur attendue.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
E_OUTOFMEMORY	Mémoire insuffisante.

Remarques

Cette API sérialise la valeur du champ de détail du WS_FAULT stocké dans l’objet WS_ERROR .

Cette fonction prend en charge les scénarios suivants, en fonction du contenu des WS_ELEMENT_DESCRIPTION dans le WS_FAULT_DETAIL_DESCRIPTION fourni :

Écriture d’un élément unique. Dans ce cas, les champs elementLocalName et elementNs de l’WS_ELEMENT_DESCRIPTION doivent être définis sur le nom local et l’espace de noms de l’élément à écrire, et le type et la description du type représentent le type de la valeur sérialisée.
Écriture de plusieurs éléments en tant que valeur unique. Dans ce cas, les champs elementLocalName et elementNs du WS_ELEMENT_DESCRIPTION doivent être définis sur NULL, et un WS_STRUCT_TYPE et un WS_STRUCT_DESCRIPTION doivent être spécifiés. Chaque champ de la valeur de structure en cours de sérialisation doit correspondre au ou aux éléments à écrire dans le détail de l’erreur. Le paramètre writeOption doit être WS_WRITE_REQUIRED_VALUE ou WS_WRITE_REQUIRED_POINTER.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	webservices.h
Bibliothèque	WebServices.lib
DLL	WebServices.dll

Partager via