WsReadXmlBuffer function (webservices.h)

Article
02/22/2024

Reads the current node from a reader into a WS_XML_BUFFER.

Syntax

HRESULT WsReadXmlBuffer(
  [in]           WS_XML_READER *reader,
  [in]           WS_HEAP       *heap,
                 WS_XML_BUFFER **xmlBuffer,
  [in, optional] WS_ERROR      *error
);

Parameters

[in] reader

The reader from which to read into the XML buffer.

[in] heap

The heap from which to allocate the XML buffer.

xmlBuffer

The XML buffer is returned here.

[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
E_INVALIDARG	One or more arguments are invalid.
WS_E_INVALID_OPERATION	The operation is not allowed due to the current state of the object.
WS_E_QUOTA_EXCEEDED	A quota was exceeded.

Remarks

If the reader must be positioned at either WS_XML_NODE_TYPE_BOF, or WS_XML_NODE_TYPE_ELEMENT.

If the reader is positioned at WS_XML_NODE_TYPE_BOF, then the entire document will be copied from the reader into the XML buffer.

If the reader is positioned at WS_XML_NODE_TYPE_ELEMENT, then the element and all its children will be read into the XML buffer.

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