Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inDbCommand.ExecuteReaderAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results.
Overloads
| ExecuteReaderAsync() |
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results. Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) with CancellationToken.None. |
| ExecuteReaderAsync(CommandBehavior) |
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results. Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken). |
| ExecuteReaderAsync(CancellationToken) |
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results. Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken). |
| ExecuteReaderAsync(CommandBehavior, CancellationToken) |
Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken). |
Remarks
Managed provider implementers must call ExecuteDbDataReaderAsync in ExecuteReaderAsync. For more information about asynchronous programming, see Asynchronous Programming.
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results.
Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) with CancellationToken.None.
public:
System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteReaderAsync();C#
public System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteReaderAsync();member this.ExecuteReaderAsync : unit -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>Public Function ExecuteReaderAsync () As Task(Of DbDataReader)Returns
A task representing the asynchronous operation.
Exceptions
An error occurred while executing the command.
An invalid CommandBehavior value.
Remarks
Managed provider implementers must call ExecuteDbDataReaderAsync in ExecuteReaderAsync. For more information about asynchronous programming, see Asynchronous Programming.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ExecuteReader().
See also
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results.
Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken).
public:
System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteReaderAsync(System::Data::CommandBehavior behavior);C#
public System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteReaderAsync(System.Data.CommandBehavior behavior);member this.ExecuteReaderAsync : System.Data.CommandBehavior -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>Public Function ExecuteReaderAsync (behavior As CommandBehavior) As Task(Of DbDataReader)Parameters
- behavior
- CommandBehavior
One of the enumeration values that specifies how the command should execute and how data should be retrieved.
Returns
A task representing the asynchronous operation.
Exceptions
An error occurred while executing the command.
An invalid CommandBehavior value.
Remarks
Managed provider implementers must call ExecuteDbDataReaderAsync in ExecuteReaderAsync. For more information about asynchronous programming, see Asynchronous Programming.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ExecuteReader(CommandBehavior).
See also
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader that can be used to access the results.
Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken).
public:
System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteReaderAsync(System::Threading::CancellationToken cancellationToken);C#
public System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteReaderAsync(System.Threading.CancellationToken cancellationToken);member this.ExecuteReaderAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>Public Function ExecuteReaderAsync (cancellationToken As CancellationToken) As Task(Of DbDataReader)Parameters
- cancellationToken
- CancellationToken
A token to cancel the asynchronous operation.
Returns
A task representing the asynchronous operation.
Exceptions
An error occurred while executing the command.
An invalid CommandBehavior value.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
Managed provider implementers must call ExecuteDbDataReaderAsync in ExecuteReaderAsync. For more information about asynchronous programming, see Asynchronous Programming.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ExecuteReader().
See also
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
- Source:
- DbCommand.cs
public:
System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteReaderAsync(System::Data::CommandBehavior behavior, System::Threading::CancellationToken cancellationToken);C#
public System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteReaderAsync(System.Data.CommandBehavior behavior, System.Threading.CancellationToken cancellationToken);member this.ExecuteReaderAsync : System.Data.CommandBehavior * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>Public Function ExecuteReaderAsync (behavior As CommandBehavior, cancellationToken As CancellationToken) As Task(Of DbDataReader)Parameters
- behavior
- CommandBehavior
One of the enumeration values that specifies the command behavior.
- cancellationToken
- CancellationToken
A token to cancel the asynchronous operation.
Returns
A task representing the asynchronous operation.
Exceptions
An error occurred while executing the command.
An invalid CommandBehavior value.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
Managed provider implementers must call ExecuteDbDataReaderAsync in ExecuteReaderAsync. For more information about asynchronous programming, see Asynchronous Programming.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ExecuteReader(CommandBehavior).
See also
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0, 2.1 |
| UWP | 10.0 |