WsWriteEndStartElement function (webservices.h)

Article
2021-10-13

Forces the writer to commit the current element and prevent further attributes from being written to the element.

Syntax

HRESULT WsWriteEndStartElement(
  [in]           WS_XML_WRITER *writer,
  [in, optional] WS_ERROR      *error
);

Parameters

[in] writer

The writer for which the current element should be committed.

[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_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
WS_E_QUOTA_EXCEEDED	A quota was exceeded.

Remarks

Occasionally, it is useful to explicitly force the completion of an element. This can be used to force the writer to write a full element and pair. It also may be useful when obtaining positions when writing to a WS_XML_BUFFER.

Calling this API when there is no element to commit will cause it to return WS_E_INVALID_OPERATION. (See Windows Web Services Return Values.)

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