WsWriteEndStartElement function
Forces the writer to commit the current element and prevent further attributes from being written to the element.
Syntax
HRESULT WINAPI WsWriteEndStartElement( _In_ WS_XML_WRITER* writer, _In_opt_ WS_ERROR* error );
Parameters
- writer [in]
-
The writer for which the current element should be committed.
- 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.
| Return code | Description |
|---|---|
|
One or more arguments are invalid. |
|
The operation is not allowed due to the current state of the object. |
|
The input data was not in the expected format or did not have the expected value. |
|
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
|
Minimum supported client | Windows 7 [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server | Windows Server 2008 R2 [desktop apps | Windows Store apps] |
|
Header |
|
|
Library |
|
|
DLL |
|