XmlWriter.WriteCommentAsync(String) Method
Definition
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 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);public virtual System.Threading.Tasks.Task WriteCommentAsync (string? text);abstract member WriteCommentAsync : string -> System.Threading.Tasks.Task
override this.WriteCommentAsync : string -> System.Threading.Tasks.TaskPublic Overridable Function WriteCommentAsync (text As String) As TaskParameters
- 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.
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 WriteComment(String).
