XmlReader.ReadOuterXmlAsync Method

Definition

Asynchronously reads the content, including markup, representing this node and all its children.

public:
 virtual System::Threading::Tasks::Task<System::String ^> ^ ReadOuterXmlAsync();
public virtual System.Threading.Tasks.Task<string> ReadOuterXmlAsync ();
abstract member ReadOuterXmlAsync : unit -> System.Threading.Tasks.Task<string>
override this.ReadOuterXmlAsync : unit -> System.Threading.Tasks.Task<string>
Public Overridable Function ReadOuterXmlAsync () As Task(Of String)

Returns

If the reader is positioned on an element or an attribute node, this method returns all the XML content, including markup, of the current node and all its children; otherwise, it returns an empty string.

Exceptions

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

Remarks

This is the asynchronous version of ReadOuterXml, 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 ReadOuterXml().

Applies to

See also