XmlReader.ReadContentAsStringAsync Method

Definition

Asynchronously reads the text content at the current position as a String object.

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

Returns

The text content as a String object.

Exceptions

An XmlReader 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 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 ReadContentAsString, 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 ReadContentAsString().

Applies to

See also