DbDataReader.GetFieldValueAsync 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.
Asynchronously gets the value of the specified column as the requested type.
Overloads
| GetFieldValueAsync<T>(Int32) |
Asynchronously gets the value of the specified column as the requested type. |
| GetFieldValueAsync<T>(Int32, CancellationToken) |
Asynchronously gets the value of the specified column as the requested type. |
GetFieldValueAsync<T>(Int32)
- Source:
- DbDataReader.cs
- Source:
- DbDataReader.cs
- Source:
- DbDataReader.cs
Asynchronously gets the value of the specified column as the requested type.
public:
generic <typename T>
System::Threading::Tasks::Task<T> ^ GetFieldValueAsync(int ordinal);public System.Threading.Tasks.Task<T> GetFieldValueAsync<T> (int ordinal);member this.GetFieldValueAsync : int -> System.Threading.Tasks.Task<'T>Public Function GetFieldValueAsync(Of T) (ordinal As Integer) As Task(Of T)Type Parameters
- T
The type of the value to be returned.
Parameters
- ordinal
- Int32
The zero-based column ordinal.
Returns
A task whose Result contains the value of the specified column.
Exceptions
The connection was dropped or closed during data retrieval.
-or-
The data reader was closed during the data retrieval.
-or-
There is no data ready to be read (for example, the first Read() hasn't been called, or it returned false).
-or-
Tried to read a previously-read column in sequential mode.
-or-
There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream.
The column index is out of range.
The value returned by the database doesn't match or cannot be cast to T.
Remarks
This asynchronous method is only needed to avoid blocking the calling thread when the reader is created in sequential mode.
If sequential mode isn't specified, all column values should become available in memory each time ReadAsync completes, and calling the synchronous version of the method shouldn't block the calling thread.
The default implementation of this asynchronous method invokes its synchronous counterpart and returns a completed Task, potentially blocking the calling thread.
Data providers that support asynchronous programming should override the default implementation using asynchronous I/O operations.
Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed.
Applies to
GetFieldValueAsync<T>(Int32, CancellationToken)
- Source:
- DbDataReader.cs
- Source:
- DbDataReader.cs
- Source:
- DbDataReader.cs
Asynchronously gets the value of the specified column as the requested type.
public:
generic <typename T>
virtual System::Threading::Tasks::Task<T> ^ GetFieldValueAsync(int ordinal, System::Threading::CancellationToken cancellationToken);public virtual System.Threading.Tasks.Task<T> GetFieldValueAsync<T> (int ordinal, System.Threading.CancellationToken cancellationToken);abstract member GetFieldValueAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>
override this.GetFieldValueAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>Public Overridable Function GetFieldValueAsync(Of T) (ordinal As Integer, cancellationToken As CancellationToken) As Task(Of T)Type Parameters
- T
The type of the value to be returned.
Parameters
- ordinal
- Int32
The zero-based column ordinal.
- cancellationToken
- CancellationToken
A token to cancel the asynchronous operation.
Returns
A task whose Result contains the value of the specified column.
Exceptions
The connection was dropped or closed during data retrieval.
-or-
The data reader was closed during the data retrieval.
-or-
There is no data ready to be read (for example, the first Read() hasn't been called, or it returned false).
-or-
Tried to read a previously-read column in sequential mode.
-or-
There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream.
The column index is out of range.
The value returned by the database doesn't match or cannot be cast to T.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This asynchronous method is only needed to avoid blocking the calling thread when the reader is created in sequential mode.
If sequential mode isn't specified, all column values should become available in memory each time ReadAsync completes, and calling the synchronous version of the method shouldn't block the calling thread.
The default implementation of this asynchronous method invokes its synchronous counterpart and returns a completed Task, potentially blocking the calling thread. The default implementation also returns a cancelled task if passed an already cancelled cancellation token.
Data providers that support asynchronous programming should override the default implementation using asynchronous I/O operations.
This method accepts a cancellation token that can be used to request the operation to be cancelled early. Implementations may ignore this request.
Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed.
