XmlWriter.WriteStartElementAsync(String, String, String) Method

Reference

Definition

Namespace:: System.Xml

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Source:: XmlWriterAsync.cs

Source:: XmlWriterAsync.cs

Source:: XmlWriterAsync.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Asynchronously writes the specified start tag and associates it with the given namespace and prefix.

public:
 virtual System::Threading::Tasks::Task ^ WriteStartElementAsync(System::String ^ prefix, System::String ^ localName, System::String ^ ns);

public virtual System.Threading.Tasks.Task WriteStartElementAsync (string prefix, string localName, string ns);

public virtual System.Threading.Tasks.Task WriteStartElementAsync (string? prefix, string localName, string? ns);

abstract member WriteStartElementAsync : string * string * string -> System.Threading.Tasks.Task
override this.WriteStartElementAsync : string * string * string -> System.Threading.Tasks.Task

Public Overridable Function WriteStartElementAsync (prefix As String, localName As String, ns As String) As Task

Parameters

prefix: String

The namespace prefix of the element.

localName: String

The local name of the element.

ns: String

The namespace URI to associate with the element.

Returns

Task

The task that represents the asynchronous WriteStartElement operation.

Exceptions

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."

-or-

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."

Remarks

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WriteStartElement(String, String, String).

Applies to