SqlBatch.PrepareAsync(CancellationToken) 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.
Asynchronously creates a prepared (or compiled) version of the batch, or of each of its commands, on the data source.
public override System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = default);override this.PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overrides Function PrepareAsync (Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- cancellationToken
- CancellationToken
An optional token to cancel the asynchronous operation. The default value is None.
Returns
A Task representing the asynchronous operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
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 Prepare().