DbCommand.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) Метод

  • Ссылка

Определение

Пространство имен:
System.Data.Common
Сборка:
System.Data.Common.dll
Сборка:
System.Data.dll
Сборка:
netstandard.dll
Исходный код:
DbCommand.cs
Исходный код:
DbCommand.cs
Исходный код:
DbCommand.cs

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

Реализация по умолчанию вызывает синхронный метод ExecuteReader() и возвращает завершенную задачу, блокируя вызывающий поток. Реализация по умолчанию возвращает отмененную задачу, если ей передается уже отмененный токен отмены. Исключения, создаваемые ExecuteReader, будут связаны через возвращаемое свойство исключения задачи.

Этот метод принимает токен отмены, который может использоваться для запроса ранней отмены операции. Реализации могут игнорировать данный запрос.

protected:
 virtual System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteDbDataReaderAsync(System::Data::CommandBehavior behavior, System::Threading::CancellationToken cancellationToken);
protected virtual System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteDbDataReaderAsync (System.Data.CommandBehavior behavior, System.Threading.CancellationToken cancellationToken);
abstract member ExecuteDbDataReaderAsync : System.Data.CommandBehavior * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>
override this.ExecuteDbDataReaderAsync : System.Data.CommandBehavior * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>
Protected Overridable Function ExecuteDbDataReaderAsync (behavior As CommandBehavior, cancellationToken As CancellationToken) As Task(Of DbDataReader)

Параметры

behavior
CommandBehavior

Экземпляр CommandBehavior, задающий параметры для выполнения команд и получения данных.

cancellationToken
CancellationToken

Токен для отмены асинхронной операции.

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

Task<DbDataReader>

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

Исключения

DbException

При выполнении команды произошла ошибка.

ArgumentException

Недопустимое значение CommandBehavior.

OperationCanceledException

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

Комментарии

Дополнительные сведения об асинхронном программировании см. в разделе Асинхронное программирование.

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

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

См. также раздел