Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

WsRemoveMappedHeader function

Removes all instances of a mapped header from the message.

Syntax


HRESULT WINAPI  WsRemoveMappedHeader(
  _In_     WS_MESSAGE*          message,
  _In_     const WS_XML_STRING* headerName,
  _In_opt_ WS_ERROR*            error
);

Parameters

message [in]

The message to set the header in.

The message can be in any state but WS_MESSAGE_STATE_EMPTY.

headerName [in]

The name of the mapped header to remove.

error [in, optional]

Specifies where additional error information should be stored if the function fails.

Return value

This function can return one of these values.

Return codeDescription
E_INVALIDARG

One or more of the parameters are incorrect.

Other Errors

This function may return other errors not listed above.

 

Remarks

A message may contain additional transport-specific information that is not part of the message envelope. This transport-specific information can be exposed programmatically as headers of the Message object. This function is used to remove mapped headers from the message object. This can be used by a custom channel implementation to remove mapped headers prior to sending the message.

Requirements

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

Show:
© 2016 Microsoft