SqlBulkCopy.WriteToServerAsync Method (DataTable, DataRowState, CancellationToken)

.NET Framework (current version)
 

The asynchronous version of WriteToServer, which copies only rows that match the supplied row state in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy 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.

Namespace:   System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

public Task WriteToServerAsync(
	DataTable table,
	DataRowState rowState,
	CancellationToken cancellationToken
)

Parameters

table
Type: System.Data.DataTable

A DataTable whose rows will be copied to the destination table.

rowState
Type: System.Data.DataRowState

A value from the DataRowState enumeration. Only rows matching the row state are copied to the destination.

cancellationToken
Type: System.Threading.CancellationToken

The cancellation instruction. A None value in this parameter makes this method equivalent to WriteToServerAsync.

Return Value

Type: System.Threading.Tasks.Task

A task representing the asynchronous operation.

Exception Condition
InvalidOperationException

Calling WriteToServerAsync multiple times for the same instance before task completion.

Calling WriteToServerAsync and WriteToServer for the same instance before task completion.

The connection drops or is closed during WriteToServerAsync execution.

Returned in the task object, the SqlBulkCopy object was closed during the method execution.

Returned in the task object, there was a connection pool timeout.

Returned in the task object, the SqlConnection object is closed before method execution.

Context Connection=true is specified in the connection string.

SqlException

Returned in the task object, any error returned by SQL Server that occurred while opening the connection.

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

.NET Framework
Available since 4.5
Return to top
Show: