nf-webservices-wscheckmustunderstandheaders.md

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.WsCheckMustUnderstandHeaders	WsCheckMustUnderstandHeaders function (webservices.h)	Verifies that the specified headers were understood by the receiver. Note  This function should be called after all headers have been read for a received message.  .	WsCheckMustUnderstandHeaders WsCheckMustUnderstandHeaders function [Web Services for Windows] webservices/WsCheckMustUnderstandHeaders wsw.wscheckmustunderstandheaders	wsw\wscheckmustunderstandheaders.htm	wsw	28ca98e5-911b-436d-a592-781b832ca6cc	12/05/2018	WsCheckMustUnderstandHeaders, WsCheckMustUnderstandHeaders function [Web Services for Windows], webservices/WsCheckMustUnderstandHeaders, wsw.wscheckmustunderstandheaders	webservices.h		Windows	Windows 7 [desktop apps \| UWP apps]	Windows Server 2008 R2 [desktop apps \| UWP apps]										WebServices.lib	WebServices.dll		Windows			19H1	WsCheckMustUnderstandHeaders webservices/WsCheckMustUnderstandHeaders	c++	APIRef kbSyntax	DllExport	WebServices.dll	WsCheckMustUnderstandHeaders

WsCheckMustUnderstandHeaders function

-description

Verifies that the specified headers were understood by the receiver.

Note  This function should be called after all headers have been read for a received message.

 

-parameters

-param message [in]

Pointer to the WS_MESSAGE structure containing the headers to be understood.

-param error [in, optional]

Pointer to a WS_ERROR structure where additional error information is stored if the function fails.

-returns

If the function succeeds, it returns NO_ERROR; otherwise, it returns an HRESULT error code.

Return code	Description
WS_E_INVALID_OPERATION	The message is not in the correct state. For more information, see the Remarks section.
WS_E_INVALID_FORMAT	The validation failed, or the message was not correctly formed.
E_INVALIDARG	One or more arguments are invalid.
E_OUTOFMEMORY	Insufficient memory to complete the operation.
Other Errors	This function may return other errors not listed above.

-remarks

Because the set of headers is extensible, it is necessary to determine whether a message has been sufficiently understood to be processed. Therefore, the sender can use this function to indicate which headers must be understood, which headers can be treated as optional or informational.

Standard addressing headers, such as the ones defined in WS_HEADER_TYPE, are automatically assumed to be understood, even if they are never read by calling WsGetHeader.

Custom, application-defined headers that are read by WsGetCustomHeader are also assumed to be understood. Calling WsGetCustomHeader will automatically mark the particular header as understood.

For any other header processed by the application, the application must explicitly mark the header as understood by calling WsMarkHeaderAsUnderstood. Otherwise, the header is considered to not be understood.

This function should be called after all headers have been read for a received message. An exception to having to call this function is the case of an intermediary that forwards the message to another node without changing its identity (message ID), since the final node will do the check.

The function will fail if any of the specified headers were not understood. If an error object is supplied to the function, it will be populated with information that can be used to send a fault (see WsCreateFaultFromError).

The message must be in the WS_MESSAGE_STATE_READING state.