DbCommand.PrepareAsync(CancellationToken) Метод

  • Ссылка

Определение

Пространство имен:
System.Data.Common
Сборка:
System.Data.Common.dll
Сборка:
netstandard.dll
Source:
DbCommand.cs
Source:
DbCommand.cs
Source:
DbCommand.cs

Асинхронно создает подготовленную (или скомпилированную) версию команды в источнике данных.

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.Task
Public Overridable Function PrepareAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Параметры

cancellationToken
CancellationToken

Необязательный токен для отмены асинхронной операции. Значение по умолчанию — None.

Возвращаемое значение

Task

Task, представляющий асинхронную операцию.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

Комментарии

Реализация этого асинхронного метода по умолчанию делегирует его синхронному аналогу и возвращает завершенный Taskобъект , потенциально блокирующий вызывающий поток.

Поставщики данных, поддерживающие асинхронное программирование , должны переопределять реализацию по умолчанию с помощью асинхронных операций ввода-вывода.

CommandType Если свойство имеет значение TableDirect, PrepareAsync ничего не делает. Если CommandType для задано значение StoredProcedure, вызов PrepareAsync должен завершиться успешно, хотя это может привести к отключению операции.

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Prepare().

Применяется к