WriteStartDocumentAsync Method
Collapse the table of content
Expand the table of content

XmlWriter.WriteStartDocumentAsync Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Asynchronously writes the XML declaration with the version "1.0".

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public virtual Task WriteStartDocumentAsync()

Return Value

Type: System.Threading.Tasks.Task
The task that represents the asynchronous WriteStartDocument operation.

ExceptionCondition
InvalidOperationException

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

InvalidOperationException

An XmlWriter asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message “Set XmlWriterSettings.Async to true if you want to use Async Methods.”

This is the asynchronous version of WriteStartDocument(), with the same functionality. To use this method, you must set the Async flag to true.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2016 Microsoft