DataReaderExtensions.GetFieldValueAsync<T> Méthode

Définition

Espace de noms:

System.Data

Assembly:

System.Data.Common.dll

Source:

DataReaderExtensions.cs

Obtient de manière asynchrone la valeur de la colonne spécifiée comme type demandé.

public static System.Threading.Tasks.Task<T> GetFieldValueAsync<T> (this System.Data.Common.DbDataReader reader, string name, System.Threading.CancellationToken cancellationToken = default);

static member GetFieldValueAsync : System.Data.Common.DbDataReader * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>

<Extension()>
Public Function GetFieldValueAsync(Of T) (reader As DbDataReader, name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)

Paramètres de type

T

Type de la valeur à retourner.

Paramètres

reader

DbDataReader

Lecteur de données à partir duquel obtenir la valeur de colonne.

name

String

Nom de la colonne.

cancellationToken

CancellationToken

Jeton facultatif pour annuler l’opération asynchrone.

Retours

Task<T>

Tâche dont Result contient la valeur de la colonne spécifiée.

Exceptions

InvalidOperationException

La connexion a été supprimée ou fermée pendant la récupération des données.

- ou -

Le lecteur de données a été fermé pendant la récupération des données.

- ou -

Il n’existe aucune donnée prête à être lue (par exemple, le premier Read() n’a pas été appelé ou a retourné false).

- ou -

Tentative de lecture d'une colonne précédemment lue en mode séquentiel.

- ou -

Il y avait une opération asynchrone en cours. Cela s’applique à toutes les méthodes Get_*_ exécutées en mode séquentiel, car elles peuvent être appelées pendant la lecture d’un flux.

IndexOutOfRangeException

Le nom spécifié n'est pas un nom de colonne valide.

InvalidCastException

La valeur retournée par la base de données ne correspond pas ou ne peut pas être castée en T.

OperationCanceledException

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

Remarques

Cette méthode asynchrone est uniquement nécessaire pour éviter de bloquer le thread appelant lorsque le lecteur est créé en mode séquentiel.

Si le mode séquentiel n’est pas spécifié, toutes les valeurs de colonne doivent être disponibles en mémoire chaque fois que ReadAsync se termine, et l’appel de la version synchrone de la méthode ne doit pas bloquer le thread appelant.

L’implémentation par défaut de cette méthode asynchrone appelle son équivalent synchrone et retourne une tâche terminée, ce qui bloque potentiellement le thread appelant. L’implémentation par défaut retourne également une tâche annulée si un jeton d’annulation déjà annulé est passé.

Les fournisseurs de données qui prennent en charge la programmation asynchrone doivent remplacer l’implémentation par défaut à l’aide d’opérations d’E/S asynchrones.

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. Les implémentations peuvent ignorer cette demande.

Les autres méthodes et propriétés de l'objet DbDataReader ne doivent pas être appelées tant que la tâche retournée n'est pas terminée.