Freigeben über


XmlWriter.WriteCommentAsync(String) Methode

Definition

Schreibt asynchron einen Kommentar <--...--,> der den angegebenen Text enthält.

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

Parameter

text
String

Text, der innerhalb des Kommentars platziert werden soll.

Gibt zurück

Die Aufgabe, die den asynchronen WriteComment Vorgang darstellt.

Ausnahmen

Eine XmlWriter Methode wurde aufgerufen, bevor ein vorheriger asynchroner Vorgang abgeschlossen wurde. In diesem Fall InvalidOperationException wird die Meldung "Ein asynchroner Vorgang wird bereits ausgeführt" ausgelöst.

- oder -

Eine XmlWriter asynchrone Methode wurde aufgerufen, ohne die Async Kennzeichnung auf .true In diesem Fall wird die Meldung "Set XmlWriterSettings.Async to true" ausgelöst, InvalidOperationException wenn Sie Async-Methoden verwenden möchten.

Hinweise

Dies ist die asynchrone Version von WriteComment, mit der gleichen Funktionalität. Um diese Methode zu verwenden, müssen Sie das Async Kennzeichen auf true.

Diese Methode speichert in der Aufgabe, die alle Nicht-Verwendungs-Ausnahmen zurückgibt, die das synchrone Gegenstück der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Verwendungsausnahmen, z. B. ArgumentException, werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie in den von WriteComment(String).

Gilt für:

Weitere Informationen