XmlWriter.WriteNodeAsync Method

Definition

Asynchronously copies everything from the source object to the current writer instance.

Overloads

WriteNodeAsync(XPathNavigator, Boolean)

Asynchronously copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged.

WriteNodeAsync(XmlReader, Boolean)

Asynchronously copies everything from the reader to the writer and moves the reader to the start of the next sibling.

Remarks

This is the asynchronous version of WriteNode, with the same functionality. To use this method, you must set the Async flag to true.

WriteNodeAsync(XPathNavigator, Boolean)

Asynchronously copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged.

public:
 virtual System::Threading::Tasks::Task ^ WriteNodeAsync(System::Xml::XPath::XPathNavigator ^ navigator, bool defattr);
public virtual System.Threading.Tasks.Task WriteNodeAsync (System.Xml.XPath.XPathNavigator navigator, bool defattr);
abstract member WriteNodeAsync : System.Xml.XPath.XPathNavigator * bool -> System.Threading.Tasks.Task
override this.WriteNodeAsync : System.Xml.XPath.XPathNavigator * bool -> System.Threading.Tasks.Task
Public Overridable Function WriteNodeAsync (navigator As XPathNavigator, defattr As Boolean) As Task

Parameters

navigator
XPathNavigator

The XPathNavigator to copy from.

defattr
Boolean

true to copy the default attributes; otherwise, false.

Returns

The task that represents the asynchronous WriteNode operation.

Exceptions

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

-or-

An XmlWriter asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."

Remarks

This is the asynchronous version of WriteNode, with the same functionality. To use this method, you must set the Async flag to true.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WriteNode(XPathNavigator, Boolean).

See also

Applies to

WriteNodeAsync(XmlReader, Boolean)

Asynchronously copies everything from the reader to the writer and moves the reader to the start of the next sibling.

public:
 virtual System::Threading::Tasks::Task ^ WriteNodeAsync(System::Xml::XmlReader ^ reader, bool defattr);
public virtual System.Threading.Tasks.Task WriteNodeAsync (System.Xml.XmlReader reader, bool defattr);
abstract member WriteNodeAsync : System.Xml.XmlReader * bool -> System.Threading.Tasks.Task
override this.WriteNodeAsync : System.Xml.XmlReader * bool -> System.Threading.Tasks.Task
Public Overridable Function WriteNodeAsync (reader As XmlReader, defattr As Boolean) As Task

Parameters

reader
XmlReader

The XmlReader to read from.

defattr
Boolean

true to copy the default attributes from the XmlReader; otherwise, false.

Returns

The task that represents the asynchronous WriteNode operation.

Exceptions

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

-or-

An XmlWriter asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."

Remarks

This is the asynchronous version of WriteNode, with the same functionality. To use this method, you must set the Async flag to true.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WriteNode(XmlReader, Boolean).

See also

Applies to