ConnectionHelper.ExecuteScalarAsync Method (String, QueryDataParameters, QueryTypeEnum, CancellationToken, Boolean)

Executes the query asynchronously and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored.

The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.

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

Syntax

public static Task<Object> ExecuteScalarAsync(
	string queryText,
	QueryDataParameters parameters,
	QueryTypeEnum queryType,
	CancellationToken cancellationToken,
	bool transaction = false
)

Parameters

queryText

Type: System.String
Query text.

parameters

Type: CMS.DataEngine.QueryDataParameters
Query parameters.

queryType

Type: CMS.DataEngine.QueryTypeEnum
Query type.

cancellationToken

Type: System.Threading.CancellationToken
The cancellation instruction.

transaction (Optional)

Type: System.Boolean
If true, connection uses transaction for the query.

Return Value

Type: Task<Object>
A task representing the asynchronous operation.