XmlWriterSettings.Async Property

Definition

Namespace:: System.Xml

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

public:
 property bool Async { bool get(); void set(bool value); };

public bool Async { get; set; }

member this.Async : bool with get, set

Public Property Async As Boolean

Property Value

Boolean

true if asynchronous methods can be used; otherwise, false.

Remarks

You must set this value to true when you create a new XmlWriter instance if you want to use asynchronous XmlWriter methods on that instance. After the XmlWriter instance is created, the Async property is read-only. The default value of this property is false.

This flag is ignored by the XmlWriter.Create overload. This means that if you create a new XmlWriter based on an existing XmlWriter, the async behavior depends on the input XmlWriter, and you cannot use the Async flag to change the async behavior.

Applies to