DataQueryBase<TQuery>.GetReaderAsync Method

Asynchronously executes the query using DB data reader. The SupportsReader flag indicates whether this operation is supported.

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

protected virtual Task<IDataReader> GetReaderAsync(
	CommandBehavior commandBehavior,
	bool newConnection,
	CancellationToken cancellationToken
)

Parameters

commandBehavior

Type: System.Data.CommandBehavior
Command behavior for the reader.

newConnection

Type: System.Boolean
If true, the reader will be executed using its own dedicated connection.

cancellationToken

Type: System.Threading.CancellationToken
The cancellation instruction.

Return Value

Type: Task<IDataReader>
Returns a task returning either the data reader resulting from query execution, or null.

Exceptions

Exception	Condition
NotSupportedException	Thrown when the query does not support reader.

Remarks

The method returns a task returning null if ReturnsNoResults indicates the query won't result in any results.