SqlDataReader.ReadAsync(CancellationToken) Metoda

Definicja

Asynchroniczna wersja programu Read(), która przechodzi SqlDataReader do następnego rekordu.

Token anulowania może służyć do żądania, aby operacja została porzucona przed upływem limitu czasu polecenia. Wyjątki będą zgłaszane za pośrednictwem zwróconego obiektu 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)

Parametry

cancellationToken
CancellationToken

Instrukcja anulowania.

Zwraca

Zadanie reprezentujące operację asynchroniczną.

Wyjątki

Wywołanie ReadAsync(CancellationToken) więcej niż raz dla tego samego wystąpienia przed ukończeniem zadania.

Context Connection=trueparametr jest określony w parametry połączenia.

SQL Server zwrócił błąd podczas wykonywania tekstu polecenia.

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Jeśli parametr parametru ExecuteReaderAsyncbehavior jest ustawiony na Default, ReadAsync odczytuje cały wiersz przed zwróceniem zadania.

Aby uzyskać więcej informacji, w tym przykłady kodu, dotyczące programowania asynchronicznego w dostawcy danych .NET Framework dla SQL Server, zobacz Programowanie asynchroniczne.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez Read()usługę .

Dotyczy

Zobacz też