XmlWriter.WriteStartDocumentAsync Method

Definition

Asynchronously writes the XML declaration.

Overloads

WriteStartDocumentAsync()

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

WriteStartDocumentAsync(Boolean)

Asynchronously writes the XML declaration with the version "1.0" and the standalone attribute.

Remarks

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

WriteStartDocumentAsync()

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

public:
 virtual System::Threading::Tasks::Task ^ WriteStartDocumentAsync();
public virtual System.Threading.Tasks.Task WriteStartDocumentAsync ();
abstract member WriteStartDocumentAsync : unit -> System.Threading.Tasks.Task
override this.WriteStartDocumentAsync : unit -> System.Threading.Tasks.Task
Public Overridable Function WriteStartDocumentAsync () As Task

Returns

The task that represents the asynchronous WriteStartDocument operation.

Exceptions

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 WriteStartDocument, 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 WriteStartDocument().

See also

Applies to

WriteStartDocumentAsync(Boolean)

Asynchronously writes the XML declaration with the version "1.0" and the standalone attribute.

public:
 virtual System::Threading::Tasks::Task ^ WriteStartDocumentAsync(bool standalone);
public virtual System.Threading.Tasks.Task WriteStartDocumentAsync (bool standalone);
abstract member WriteStartDocumentAsync : bool -> System.Threading.Tasks.Task
override this.WriteStartDocumentAsync : bool -> System.Threading.Tasks.Task
Public Overridable Function WriteStartDocumentAsync (standalone As Boolean) As Task

Parameters

standalone
Boolean

If true, it writes "standalone=yes"; if false, it writes "standalone=no".

Returns

The task that represents the asynchronous WriteStartDocument operation.

Exceptions

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 WriteStartDocument, 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 WriteStartDocument(Boolean).

See also

Applies to