Partilhar via


XmlWriter.WriteCommentAsync(String) Método

Definição

Grava de forma assíncrona um comentário <--...--> que contém o texto especificado.

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.Task
Public Overridable Function WriteCommentAsync (text As String) As Task

Parâmetros

text
String

Texto a ser colocado dentro do comentário.

Retornos

A tarefa que representa a operação assíncrona WriteComment .

Exceções

Um XmlWriter método foi chamado antes de uma operação assíncrona anterior ser concluída. Nesse caso, InvalidOperationException é lançada com a mensagem "Uma operação assíncrona já está em andamento".

- ou -

Um XmlWriter método assíncrono foi chamado sem definir o Async sinalizador como true. Nesse caso, InvalidOperationException é gerada com a mensagem "Definir XmlWriterSettings.Async como true se você quiser usar métodos assíncronos".

Comentários

Essa é a versão assíncrona de WriteComment, com a mesma funcionalidade. Para usar esse método, você deve definir o Async sinalizador como true.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por WriteComment(String).

Aplica-se a

Confira também