WsRemoveCustomHeader, fonction (webservices.h)

Supprime un en-tête personnalisé du message.

Cette fonction est conçue pour gérer les types d’en-têtes qui s’affichent une fois dans le message et qui sont ciblés sur le destinataire final. Les en-têtes ciblés avec un rôle autre que le récepteur final sont ignorés.

Syntaxe

HRESULT WsRemoveCustomHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           const WS_XML_STRING *headerNs,
  [in, optional] WS_ERROR            *error
);

Paramètres

[in] message

Pointeur vers l’objet Message avec l’en-tête à supprimer.

Le message peut être dans n’importe quel état, à l’exception de WS_MESSAGE_STATE_EMPTY.

[in] headerName

Pointeur vers l’objet WS_XML_STRING qui fait référence au « nom local » de l’élément header à supprimer.

[in] headerNs

Pointeur vers l’objet WS_XML_STRING qui fait référence à l’espace de noms de l’élément header à supprimer.

[in, optional] error

Pointeur vers un objet WS_ERROR où des informations supplémentaires sur l’erreur doivent être stockées en cas d’échec de la fonction.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Remarques

Si un en-tête du type donné existe dans le message, il est supprimé. Si l’en-tête n’existe pas, la fonction n’effectue aucune action et se termine correctement.

Configuration requise