SqlDataReader.GetFieldValueAsync<T>(Int32, CancellationToken) 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 a type. GetFieldValue<T>(Int32) is the synchronous version of this method.
public:
generic <typename T>
override System::Threading::Tasks::Task<T> ^ GetFieldValueAsync(int i, System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task<T> GetFieldValueAsync<T>(int i, System.Threading.CancellationToken cancellationToken);override this.GetFieldValueAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>Public Overrides Function GetFieldValueAsync(Of T) (i As Integer, cancellationToken As CancellationToken) As Task(Of T)Type Parameters
- T
The type of the value to be returned.
Parameters
- i
- Int32
The column to be retrieved.
- cancellationToken
- CancellationToken
The cancellation instruction, which propagates a notification that operations should be canceled. This does not guarantee the cancellation. A setting of CancellationToken.None makes this method equivalent to IsDBNull(Int32). The returned task must be marked as cancelled.
Returns
The returned type object.
Exceptions
Trying to read a column that does not exist.
The value of the column was null (IsDBNull(Int32) == true), retrieving a non-SQL type.
T doesn't match the type returned by SQL Server or cannot be cast.
Remarks
T can be one of the following types:
For more information, see SqlClient Streaming Support.