WsGetHeaderAttributes function (webservices.h)

Article
02/22/2024

This function populates a ULONG parameter with the WS_HEADER_ATTRIBUTES from the header element on which the reader is positioned. The envelope version of the message is used to determine which attributes to return.

Syntax

HRESULT WsGetHeaderAttributes(
  [in]           WS_MESSAGE    *message,
  [in]           WS_XML_READER *reader,
  [out]          ULONG         *headerAttributes,
  [in, optional] WS_ERROR      *error
);

Parameters

[in] message

A pointer to a WS_MESSAGE structure containing the message to query. This envelope version of the message is used to determine which attributes match. The message can be in any state except WS_MESSAGE_STATE_EMPTY.

[in] reader

A pointer to the reader to query. This must be valid WS_XML_READER object returned from WsCreateReader and cannot be NULL.

[out] headerAttributes

On success the value referenced by this pointer is set to the header attributes.

[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.

Return code	Description
E_OUTOFMEMORY	Ran out of memory.
E_INVALIDARG	One or more arguments are invalid.
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
Other Errors	This function may return other errors not listed above.

Remarks

The reader is assumed to point to a header element. Use the XML reader API's to position the reader appropriately.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	webservices.h
Library	WebServices.lib
DLL	WebServices.dll

Share via