WsGetWriterPosition function (webservices.h)

Article
10/13/2021

Returns the current position of the writer. This can only be used on a writer that is set to an XmlBuffer. When writing to a buffer, the position represents the xml node before which new data will be placed.

Syntax

HRESULT WsGetWriterPosition(
  [in]           WS_XML_WRITER        *writer,
  [out]          WS_XML_NODE_POSITION *nodePosition,
  [in, optional] WS_ERROR             *error
);

Parameters

[in] writer

The writer for which the current position will be obtained.

[out] nodePosition

The current position of the writer 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.

Remarks

See WS_XML_NODE_POSITION for more information on using positions.

It may be useful to call WsWriteEndStartElement to force an element to be committed before obtaining the position.

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