WsReadElement function (webservices.h)

Article
10/13/2021

Read an element producing a value of the specified WS_TYPE.

Syntax

HRESULT WsReadElement(
  [in]           WS_XML_READER                *reader,
  [in]           const WS_ELEMENT_DESCRIPTION *elementDescription,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
  [in, optional] WS_ERROR                     *error
);

Parameters

[in] reader

The reader that is positioned on the XML to deserialize.

[in] elementDescription

A pointer to a description of how to deserialize the element.

[in] readOption

Whether the element is required, and how to allocate the value.
See WS_READ_OPTION for more information.

[in, optional] heap

The heap to store the deserialized values in.

value

The interpretation of this parameter depends on the WS_READ_OPTION.

[in] valueSize

The interpretation of this parameter depends on the WS_READ_OPTION.

[in, optional] error

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

Return value

This function can return one of these values.

Return code	Description
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
E_OUTOFMEMORY	Ran out of memory.
WS_E_QUOTA_EXCEEDED	The size quota of the heap was exceeded.
E_INVALIDARG	One or more arguments are invalid.

Remarks

This API will move to the next element, verify its name and namespace, and then and deserialize the content as a typed value.

If the API fails, the state of input reader becomes undefined. The only APIs that may be used on the reader if this occurs are WsSetInput and WsSetInputToBuffer to return the reader to a usable state, or WsFreeReader to free the reader.

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