XmlWriter.WriteCommentAsync(String) Метод

Определение

Пространство имен:

System.Xml

Сборки:

netstandard.dll, System.Xml.ReaderWriter.dll

Исходный код:

XmlWriterAsync.cs

Асинхронно записывает <комментарий, --...--> содержащий указанный текст.

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

Параметры

text

String

Текст для размещения внутри комментария.

Возвращаемое значение

Task

Задача, представляющая асинхронную WriteComment операцию.

Исключения

InvalidOperationException

Метод XmlWriter был вызван до завершения предыдущей асинхронной операции. В этом случае InvalidOperationException создается сообщение "Асинхронная операция уже выполняется".

–или–

Асинхронный XmlWriter метод был вызван без задания флага Asynctrue. В этом случае InvalidOperationException создается сообщение "Set XmlWriterSettings.Async to true, если вы хотите использовать Асинхронные методы".

Комментарии

Это асинхронная версия WriteCommentс той же функциональностью. Чтобы использовать этот метод, необходимо задать для флага Asynctrueзначение .

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых WriteComment(String).

См. также раздел

• Асинхронное программирование (C#)
• Асинхронное программирование с помощью Async и Await (Visual Basic)