XmlWriter.WriteCommentAsync(String) Method

Definition

Asynchronously writes out a comment <!--...--> containing the specified text.

public:
 virtual System::Threading::Tasks::Task ^ WriteCommentAsync(System::String ^ text);
public virtual System.Threading.Tasks.Task WriteCommentAsync (string text);
abstract member WriteCommentAsync : string -> System.Threading.Tasks.Task
override this.WriteCommentAsync : string -> System.Threading.Tasks.Task
Public Overridable Function WriteCommentAsync (text As String) As Task

Parameters

text
String

Text to place inside the comment.

Returns

The task that represents the asynchronous WriteComment 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 WriteComment, with the same functionality. To use this method, you must set the Async flag to true.

Applies to

See also