Click or drag to resize
OSIsoft, LLC

AFSearchSummaryAsync Method (String, AFSummaryTypes, String, CancellationToken)

Summarizes the result of this search with the specified weighting asynchronously.

Namespace:  OSIsoft.AF.Search
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public Task<AFSummaryResult> SummaryAsync(
	string field,
	AFSummaryTypes summaryTypes,
	string weightField,
	CancellationToken cancellationToken
)

Parameters

field
Type: SystemString
The field that should be summarized.
summaryTypes
Type: OSIsoft.AF.DataAFSummaryTypes
The summaries that should be performed on the field.
weightField
Type: SystemString
The field that should be used to weight the values being summarized.
cancellationToken
Type: System.ThreadingCancellationToken
A token to control cancellation of the aggregation request.

Return Value

Type: TaskAFSummaryResult
A result containing the requested summaries or an error if the summaries could not be performed.
Remarks

Note Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9
See Also
Enabling Operational Intelligence