ConnectionHelper.ExecuteScalarAsync Method (String, CancellationToken, QueryDataParameters, QueryMacros)

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 queryName,
	CancellationToken cancellationToken,
	QueryDataParameters parameters = null,
	QueryMacros macros = null
)

Parameters

queryName

Type: System.String
Name of the query in format application.class.queryname

cancellationToken

Type: System.Threading.CancellationToken
The cancellation instruction.

parameters (Optional)

Type: CMS.DataEngine.QueryDataParameters
Query parameters.

macros (Optional)

Type: CMS.DataEngine.QueryMacros
Query expressions.

Return Value

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