nf-webservices-wswriteelement.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:webservices.WsWriteElement	WsWriteElement function (webservices.h)	Write a typed value as an XML element.	WsWriteElement WsWriteElement function [Web Services for Windows] webservices/WsWriteElement wsw.wswriteelement	wsw\wswriteelement.htm	wsw	5416d167-b832-4815-9826-6128f68dbc02	12/05/2018	WsWriteElement, WsWriteElement function [Web Services for Windows], webservices/WsWriteElement, wsw.wswriteelement	webservices.h		Windows	Windows 7 [desktop apps \| UWP apps]	Windows Server 2008 R2 [desktop apps \| UWP apps]										WebServices.lib	WebServices.dll		Windows			19H1	WsWriteElement webservices/WsWriteElement	c++	APIRef kbSyntax	DllExport	WebServices.dll	WsWriteElement

WsWriteElement function

-description

Write a typed value as an XML element.

-parameters

-param writer [in]

The writer to write the element to.

-param elementDescription [in]

A pointer to a description of how to serialize the element.

-param writeOption [in]

Information about how the value is allocated. See WS_WRITE_OPTION for more information.

-param value

A pointer to the value to serialize.

-param valueSize [in]

The size of the value being serialized, in bytes.

If the value is NULL, then the size should be 0.

-param error [in, optional]

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

-returns

This function can return one of these values.

Return code	Description
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
E_INVALIDARG	One or more arguments are invalid.
E_OUTOFMEMORY	Ran out of memory.

-remarks

This API writes the start element, the attributes, child elements / text, and the end element that corresponds to the specified value.

If the API fails, the state of input writer becomes undefined. The only APIs that may be used on the writer if this occurs are WsSetOutput and WsSetOutputToBuffer to return the writer to a usable state, or WsFreeWriter to free the writer.