XmlReader.ReadElementContentAsObjectAsync Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlReader.cs

Asynchronously reads the current element and returns the contents as an Object.

public:
 virtual System::Threading::Tasks::Task<System::Object ^> ^ ReadElementContentAsObjectAsync();

public virtual System.Threading.Tasks.Task<object> ReadElementContentAsObjectAsync ();

abstract member ReadElementContentAsObjectAsync : unit -> System.Threading.Tasks.Task<obj>
override this.ReadElementContentAsObjectAsync : unit -> System.Threading.Tasks.Task<obj>

Public Overridable Function ReadElementContentAsObjectAsync () As Task(Of Object)

Returns

Task<Object>

A boxed common language runtime (CLR) object of the most appropriate type. The ValueType property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.

Exceptions

InvalidOperationException

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

See also

• Asynchronous programming (C#)
• Asynchronous programming with Async and Await (Visual Basic)