Skip to content

Latest commit

 

History

History
113 lines (92 loc) · 2.72 KB

nf-webservices-wsremovemappedheader.md

File metadata and controls

113 lines (92 loc) · 2.72 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:webservices.WsRemoveMappedHeader
WsRemoveMappedHeader function (webservices.h)
Removes all instances of a mapped header from the message.
WsRemoveMappedHeader
WsRemoveMappedHeader function [Web Services for Windows]
webservices/WsRemoveMappedHeader
wsw.wsremovemappedheader
wsw\wsremovemappedheader.htm
wsw
aa662c92-4fb4-47af-b260-a3dedf4c6c9a
12/05/2018
WsRemoveMappedHeader, WsRemoveMappedHeader function [Web Services for Windows], webservices/WsRemoveMappedHeader, wsw.wsremovemappedheader
webservices.h
Windows
Windows 7 [desktop apps \| UWP apps]
Windows Server 2008 R2 [desktop apps \| UWP apps]
WebServices.lib
WebServices.dll
Windows
19H1
WsRemoveMappedHeader
webservices/WsRemoveMappedHeader
c++
APIRef
kbSyntax
DllExport
WebServices.dll
WsRemoveMappedHeader

WsRemoveMappedHeader function

-description

Removes all instances of a mapped header from the message.

-parameters

-param message [in]

The message to set the header in.

The message can be in any state but WS_MESSAGE_STATE_EMPTY.

-param headerName [in]

The name of the mapped header to remove.

-param error [in, optional]

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

-returns

This function can return one of these values.

Return code Description
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.