XmlReader.ReadElementContentAsStringAsync Method

Definition

Asynchronously reads the current element and returns the contents as a String object.

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

Returns

The element content as a String object.

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 ReadElementContentAsString, 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 ReadElementContentAsString().

Applies to

See also