WsCreateFaultFromError, fonction (webservices.h)

Construit un WS_FAULT à partir d’un objet d’erreur spécifié.

Syntaxe

HRESULT WsCreateFaultFromError(
  [in]  WS_ERROR            *error,
  [in]  HRESULT             faultErrorCode,
  [in]  WS_FAULT_DISCLOSURE faultDisclosure,
  [in]  WS_HEAP             *heap,
  [out] WS_FAULT            *fault
);

Paramètres

[in] error

Pointeur vers une structure WS_ERROR représentant l’objet d’erreur à partir duquel construire l’erreur.

[in] faultErrorCode

Code d’erreur HRESULT retourné par la fonction qui a échoué. La valeur HRESULT ne peut pas être un code de réussite.

Ce code d’erreur n’est jamais inclus directement dans l’erreur, mais il est utilisé comme mécanisme de secours pour créer une chaîne d’erreur si l’objet d’erreur ne contient pas de chaînes d’erreur.

[in] faultDisclosure

WS_FAULT_DISCLOSURE énumération qui contrôle les informations copiées de l’objet d’erreur vers l’objet d’erreur.

[in] heap

Pointeur vers une structure WS_HEAP représentant le tas à partir duquel allouer de la mémoire pour l’objet d’erreur retourné.

[out] fault

Pointeur vers une structure WS_FAULT représentant l’objet d’erreur retourné. Les champs de l’objet d’erreur sont corrects jusqu’à ce que WsFreeHeap ou WsResetHeap soit appelé pour libérer les ressources de tas spécifiées.

Valeur retournée

Si la fonction réussit, elle retourne NO_ERROR ; sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si l’objet d’erreur contient une erreur (autrement dit, la valeur WS_FAULT_ERROR_PROPERTY_FAULT de WS_FAULT_ERROR_PROPERTY_ID est non NULL), cette erreur est sélectionnée pour construire l’erreur retournée.

Si l’objet d’erreur ne contient pas d’erreur (WS_FAULT_ERROR_PROPERTY_FAULT a la valeur NULL), une erreur générique avec un code d’erreur générique (et aucun texte de raison) est sélectionnée pour construire l’erreur retournée.

Si l’erreur sélectionnée n’inclut aucun texte de motif, le texte de la raison d’erreur est construit en fonction de la valeur du paramètre de divulgation :

• WS_FULL_FAULT_DISCLOSURE Toutes les chaînes d’erreur présentes dans l’objet error sont ajoutées ensemble pour former le texte de raison. S’il n’y a pas de chaînes, la chaîne associée au paramètre errorCode est utilisée.
• WS_MINIMAL_FAULT_DISCLOSURE Une chaîne d’erreur générique est utilisée.

Par défaut, la langue de toutes les informations dépendantes de la langue dans l’objet d’erreur est la langue de l’interface utilisateur par défaut actuelle. Toutefois, vous pouvez modifier la langue en définissant la propriété WS_ERROR_PROPERTY_LANGID. Consultez l’énumération WS_ERROR_PROPERTY_ID .

Configuration requise