SqlCommand.ExecuteNonQueryAsync(CancellationToken) Method

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.8.6

An asynchronous version of ExecuteNonQuery(), which executes a Transact-SQL statement against the connection and returns the number of rows affected. 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:
 override System::Threading::Tasks::Task<int> ^ ExecuteNonQueryAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ExecuteNonQueryAsync (System.Threading.CancellationToken cancellationToken);

override this.ExecuteNonQueryAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ExecuteNonQueryAsync (cancellationToken As CancellationToken) As Task(Of Integer)

Parameters

cancellationToken

CancellationToken

The cancellation instruction.

Returns

Task<Int32>

A task representing the asynchronous operation.

Exceptions

InvalidCastException

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.

InvalidOperationException

Calling ExecuteNonQueryAsync(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.

-or-

Context Connection=true is specified in the connection string.

SqlException

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.

IOException

An error occurred in a Stream, XmlReader or TextReader object during a streaming operation. For more information about streaming, see SqlClient Streaming Support.

ObjectDisposedException

The Stream, XmlReader or TextReader object was closed during a streaming operation. For more information about streaming, see SqlClient Streaming Support.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

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 ExecuteNonQuery().

See also

• ADO.NET Overview