WsRemoveHeader, fonction (webservices.h)

Supprime l’objet WS_HEADER_TYPE standard d’un message.

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

Pour les types d’en-têtes définis par l’application, utilisez la fonction WsRemoveCustomHeader .

Syntaxe

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [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] headerType

Indique le type d’en-tête à 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, aucune action n’est effectuée et la fonction se termine correctement.

Configuration requise