SqlDataReader.ReadAsync(CancellationToken) Método

Definición

Espacio de nombres:

System.Data.SqlClient

Ensamblado:

System.Data.SqlClient.dll

Paquete:

System.Data.SqlClient v4.8.6

Una versión asincrónica de Read(), que avanza SqlDataReader al registro siguiente.

Token de cancelación que se puede usar para solicitar que se abandone la operación antes de que transcurra el tiempo de espera del comando. Las excepciones se mostrarán a través del objeto Task devuelto.

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)

Parámetros

cancellationToken

CancellationToken

Instrucción de cancelación.

Devoluciones

Task<Boolean>

Tarea que representa la operación asincrónica.

Excepciones

InvalidOperationException

Llamar a ReadAsync(CancellationToken) más de una vez para la misma instancia antes de la finalización de la tarea.

Context Connection=true se especifica en la cadena de conexión.

SqlException

SQL Server informó de un error al ejecutar el texto del comando.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Si el behavior parámetro de ExecuteReaderAsync se establece Defaulten , ReadAsync lee toda la fila antes de devolver la tarea.

Para obtener más información, incluidos los ejemplos de código, sobre la programación asincrónica en el proveedor de datos de .NET Framework para SQL Server, vea Programación asincrónica.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Read().

Consulte también

• Información general de ADO.NET