An asynchronous version of Read(), which advances the SqlDataReader to the next record.
The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
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)
Parameters Returns
A task representing the asynchronous operation.
ExceptionsCalling ReadAsync(CancellationToken) more than once for the same instance before task completion.
Context Connection=true
is specified in the connection string.
SQL Server returned an error while executing the command text.
The cancellation token was canceled. This exception is stored into the returned task.
RemarksIf the behavior
parameter of ExecuteReaderAsync is set to Default
, ReadAsync reads the entire row before returning the Task.
For more information, including code samples, about asynchronous programming in the .NET Framework Data Provider for SQL Server, 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 Read().
See alsoCollaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide. In this articleWas this page helpful?
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4