WsReadXmlBuffer function

Reads the current node from a reader into a WS_XML_BUFFER.

Syntax

HRESULT WINAPI  WsReadXmlBuffer(
  _In_     WS_XML_READER*  reader,
  _In_     WS_HEAP*        heap,
           WS_XML_BUFFER** xmlBuffer,
  _In_opt_ WS_ERROR*       error
);

Parameters

reader [in]

The reader from which to read into the XML buffer.

heap [in]

The heap from which to allocate the XML buffer.

xmlBuffer

The XML buffer is returned here.

error [in, optional]

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

Return value

This function can return one of these values.

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