SqlCommand.ExecuteXmlReaderAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ExecuteXmlReaderAsync() |
An asynchronous version of ExecuteXmlReader() , which sends the CommandText to the Connection and builds an XmlReader object. Exceptions will be reported via the returned Task object. |
| ExecuteXmlReaderAsync(CancellationToken) |
An asynchronous version of ExecuteXmlReader() , which sends the CommandText to the Connection and builds an XmlReader object. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object. |
ExecuteXmlReaderAsync()
An asynchronous version of ExecuteXmlReader() , which sends the CommandText to the Connection and builds an XmlReader object.
Exceptions will be reported via the returned Task object.
public:
System::Threading::Tasks::Task<System::Xml::XmlReader ^> ^ ExecuteXmlReaderAsync();public System.Threading.Tasks.Task<System.Xml.XmlReader> ExecuteXmlReaderAsync ();member this.ExecuteXmlReaderAsync : unit -> System.Threading.Tasks.Task<System.Xml.XmlReader>Public Function ExecuteXmlReaderAsync () As Task(Of XmlReader)Returns
A task representing the asynchronous operation.
Exceptions
A SqlDbType other than Binary or VarBinary was used when Value was set to Stream . For more information about streaming, see SqlClient Streaming Support.
-or-
A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader .
-or-
A SqlDbType other than Xml was used when Value was set to XmlReader .
Calling ExecuteScalarAsync(CancellationToken) more than once for the same instance before task completion.
-or-
The SqlConnection closed or dropped during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
SQL Server returned an error while executing the command text.
-or-
A timeout occurred during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
An error occurred in a Stream , XmlReader or TextReader object during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
The Stream , XmlReader or TextReader object was closed during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
Remarks
The XmlReader returned by this method does not support asynchronous operations. For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.
Note
For long running queries on the server, consider using ExecuteXmlReader due to a known issue with canceling queries via a cancellation token. Also, consider canceling execution using the Cancel method.
Applies to
ExecuteXmlReaderAsync(CancellationToken)
An asynchronous version of ExecuteXmlReader() , which sends the CommandText to the Connection and builds an XmlReader object.
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
public:
System::Threading::Tasks::Task<System::Xml::XmlReader ^> ^ ExecuteXmlReaderAsync(System::Threading::CancellationToken cancellationToken);public System.Threading.Tasks.Task<System.Xml.XmlReader> ExecuteXmlReaderAsync (System.Threading.CancellationToken cancellationToken);member this.ExecuteXmlReaderAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Xml.XmlReader>Public Function ExecuteXmlReaderAsync (cancellationToken As CancellationToken) As Task(Of XmlReader)Parameters
- cancellationToken
- CancellationToken
The cancellation instruction.
Returns
A task representing the asynchronous operation.
Exceptions
A SqlDbType other than Binary or VarBinary was used when Value was set to Stream . For more information about streaming, see SqlClient Streaming Support.
-or-
A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader .
-or-
A SqlDbType other than Xml was used when Value was set to XmlReader .
Calling ExecuteScalarAsync(CancellationToken) more than once for the same instance before task completion.
-or-
The SqlConnection closed or dropped during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
SQL Server returned an error while executing the command text.
-or-
A timeout occurred during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
An error occurred in a Stream , XmlReader or TextReader object during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
The Stream , XmlReader or TextReader object was closed during a streaming operation. For more information about streaming, see SqlClient Streaming Support.
Remarks
The XmlReader returned by this method does not support asynchronous operations. For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.