SqlBatch.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) Méthode

Définition

Espace de noms:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Paquet:

Microsoft.Data.SqlClient v5.2.0

Cette implémentation appelle la ExecuteReaderAsync() méthode et retourne une tâche terminée. L'implémentation par défaut retourne une tâche annulée si un jeton d'annulation déjà annulé est passé.

Cette méthode accepte un jeton d'annulation qui peut être utilisé pour demander l'annulation de l'opération plus tôt que prévu.

protected:
 override System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteDbDataReaderAsync(System::Data::CommandBehavior behavior, System::Threading::CancellationToken cancellationToken);

protected override System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteDbDataReaderAsync (System.Data.CommandBehavior behavior, System.Threading.CancellationToken cancellationToken);

override this.ExecuteDbDataReaderAsync : System.Data.CommandBehavior * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>

Protected Overrides Function ExecuteDbDataReaderAsync (behavior As CommandBehavior, cancellationToken As CancellationToken) As Task(Of DbDataReader)

Paramètres

behavior

CommandBehavior

Une des valeurs d’énumération qui spécifie les options d’exécution de lots et de récupération des données.

cancellationToken

CancellationToken

Jeton pour annuler l’opération asynchrone.

Retours

Task<DbDataReader>

Tâche représentant l’opération asynchrone.

Exceptions

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

Pour plus d’informations sur la programmation asynchrone, consultez Programmation asynchrone.

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que le équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour les exceptions stockées, consultez les exceptions levées par ExecuteDbDataReader(CommandBehavior).

Notes

Cette méthode bénéficie de ExecuteReaderAsync(CancellationToken), et toutes les exceptions attendues de cette méthode s’appliquent également ici.