DataQueryBase<TQuery>.ExecuteReaderAsync Method

Asynchronously executes the current query and returns it's results as an IDataReader. The SupportsReader flag indicates whether this operation is supported.

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

Syntax

public virtual Task<IDataReader> ExecuteReaderAsync(
	CommandBehavior commandBehavior = CommandBehavior.Default,
	bool newConnection = false,
	Nullable<CancellationToken> cancellationToken = null
)

Parameters

commandBehavior (Optional)

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

newConnection (Optional)

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

cancellationToken (Optional)

Type: System.Nullable<CancellationToken>
The cancellation instruction.

Return Value

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

Implements

IDataQuery.ExecuteReaderAsync(CommandBehavior, Boolean, Nullable<CancellationToken>)

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.