XmlWriter.WriteCommentAsync(String) Metod

Definition

Skriver asynkront ut en kommentar <--...--> som innehåller den angivna texten.

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

Parametrar

text
String

Text att placera i kommentaren.

Returer

Uppgiften som representerar den asynkrona WriteComment åtgärden.

Undantag

En XmlWriter metod anropades innan en tidigare asynkron åtgärd slutfördes. I det här fallet InvalidOperationException genereras meddelandet "En asynkron åtgärd pågår redan".

-eller-

En XmlWriter asynkron metod anropades utan att flaggan sattes Async till true. I det här fallet InvalidOperationException genereras meddelandet "Ange XmlWriterSettings.Async till sant om du vill använda Async-metoder".

Kommentarer

Det här är den asynkrona versionen av WriteComment, med samma funktioner. Om du vill använda den här metoden måste du ange Async flaggan till true.

Den här metoden lagrar i aktiviteten som returnerar alla undantag som inte används som metodens synkrona motsvarighet kan utlösa. Om ett undantag lagras i den returnerade aktiviteten utlöses undantaget när aktiviteten väntar. Användningsfel, till exempel ArgumentException, genereras fortfarande synkront. De lagrade undantagen finns i undantagen som genereras av WriteComment(String).

Gäller för

Se även