XmlWriter.WriteStartDocumentAsync Method ()

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

Public Overridable Function WriteStartDocumentAsync As Task

Return Value

Type: System.Threading.Tasks.Task

The task that represents the asynchronous WriteStartDocument operation.

Exception Condition
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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: