SqlDataReader.ReadAsync(CancellationToken) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Асинхронная версия Read(), которая перемещает SqlDataReader к следующей записи.
Токен отмены можно использовать для запроса отказа от операции до истечения времени ожидания команды. Сведения об исключениях передаются в возвращенном объекте Task.
public:
override System::Threading::Tasks::Task<bool> ^ ReadAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<bool> ReadAsync (System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Overrides Function ReadAsync (cancellationToken As CancellationToken) As Task(Of Boolean)
Параметры
- cancellationToken
- CancellationToken
Инструкция отмены.
Возвращаемое значение
Задача, представляющая асинхронную операцию.
Исключения
Вызов ReadAsync(CancellationToken) более одного раза для того же экземпляра до завершения задачи.
Context Connection=true
задается в строке подключения.
SQL Server вернул ошибку во время выполнения текста команды.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
behavior
Если параметр имеет ExecuteReaderAsync значение Default
, ReadAsync считывает всю строку перед возвратом задачи.
Дополнительные сведения, включая примеры кода, об асинхронном программировании в поставщике данных платформа .NET Framework для SQL Server см. в разделе Асинхронное программирование.
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Read().