DocumentQueryBase<TQuery, TObject>.GetEnumerableResultAsync Method

Asynchronously gets an enumeration of data records representing the result of this query. If Properties has CheckPermissions set to true, the resulting data records are filtered based on permissions.

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

Syntax

public override Task<IEnumerable<IDataRecord>> GetEnumerableResultAsync(
	CommandBehavior commandBehavior = CommandBehavior.Default,
	bool newConnection = false,
	Nullable<CancellationToken> cancellationToken = null
)

Parameters

commandBehavior (Optional)

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

newConnection (Optional)

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

cancellationToken (Optional)

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

Return Value

Type: Task<IEnumerable<IDataRecord>>
Returns a task returning the enumeration resulting from query execution.

Implements

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

Exceptions

Exception	Condition
NotSupportedException	Thrown always by this implementation.

Remarks

The returned data records can contain additional system columns (ROW_NUMBER and TOTAL_RECORDS) when a paged query is being executed. The columns support the framework infrastructure and should not be relied on in custom code.

The data records do not reflect version data. The version data are applied as part of the GetEnumerableTypedResultAsync(CommandBehavior, Boolean, Nullable<CancellationToken>) method