DbCommand.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 command on the data source.
public virtual System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = default);abstract member PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable 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
The default implementation of this asynchronous method delegates to its synchronous counterpart and returns a completed Task, potentially blocking the calling thread.
Data providers that support asynchronous programming should override the default implementation using asynchronous I/O operations.
If the CommandType property is set to TableDirect, PrepareAsync does nothing. If CommandType is set to StoredProcedure, the call to PrepareAsync should succeed, although it may result in a no-op.
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().
