SqlDataReader.ReadAsync(CancellationToken) Méthode

Définition

Espace de noms:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Paquet:

Microsoft.Data.SqlClient v5.2.0

Version asynchrone de Read(), qui avance SqlDataReader jusqu'à l'enregistrement suivant.

Le jeton d'annulation peut être utilisé pour demander que l'opération soit abandonnée avant que le délai d'attente de commande s'écoule. Les exceptions seront signalées via l’objet Task retourné.

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)

Paramètres

cancellationToken

CancellationToken

Instruction d'annulation.

Retours

Task<Boolean>

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

Exceptions

InvalidOperationException

Appels multiples de ReadAsync(CancellationToken) pour la même instance avant la fin de la tâche.

SqlException

SQL Server a retourné une erreur pendant l’exécution du texte de commande.

Remarques

Si le behavior paramètre de ExecuteReaderAsync a la valeur Default, ReadAsync lit la ligne entière avant de renvoyer la tâche.

Pour plus d’informations, notamment des exemples de code, sur la programmation asynchrone dans le fournisseur de données .NET Framework pour SQL Server, consultez Programmation asynchrone.

Notes

Lors de la lecture de données volumineuses (binaire/texte), il est recommandé d’utiliser Read pour des performances optimales.