Windows Dev Center

Expand Minimize

WsGetHeaderAttributes function

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 WINAPI  WsGetHeaderAttributes(
  _In_     WS_MESSAGE*    message,
  _In_     WS_XML_READER* reader,
  _Out_    ULONG*         headerAttributes,
  _In_opt_ WS_ERROR*      error
);

Parameters

message [in]

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.

reader [in]

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

headerAttributes [out]

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

error [in, optional]

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 codeDescription
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

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

ADD
Show:
© 2015 Microsoft