WsRemoveHeader function (webservices.h)

Removes the standard WS_HEADER_TYPE object from a message.

The function is designed to handle types of headers that appear once in the message and are targeted at the ultimate receiver. Headers targeted with a role other than ultimate receiver are ignored.

For application-defined header types use the WsRemoveCustomHeader function.

Syntax

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in, optional] WS_ERROR       *error
);

Parameters

[in] message

A pointer to the Message object with the header to be removed. The message can be in any state except WS_MESSAGE_STATE_EMPTY.

[in] headerType

Indicates the type of header to be removed.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Remarks

If a header of the given type exists in the message it is removed. If the header does not exist, no action is taken and the function completes successfully.

Requirements