Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFSearch.SummaryAsync Method (String, AFSummaryTypes, String, CancellationToken)

AFSearch.SummaryAsync Method (String, AFSummaryTypes, String, CancellationToken)

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFSearch.SummaryAsync 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: 3.1.1.1182

Syntax

public Task<AFSummaryResult> SummaryAsync(
	string field,
	AFSummaryTypes summaryTypes,
	string weightField,
	CancellationToken cancellationToken
)
Public Function SummaryAsync ( 
	field As String,
	summaryTypes As AFSummaryTypes,
	weightField As String,
	cancellationToken As CancellationToken
) As Task(Of AFSummaryResult)

Dim instance As AFSearch
Dim field As String
Dim summaryTypes As AFSummaryTypes
Dim weightField As String
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFSummaryResult)

returnValue = instance.SummaryAsync(field, 
	summaryTypes, weightField, cancellationToken)
public:
Task<AFSummaryResult^>^ SummaryAsync(
	String^ field, 
	AFSummaryTypes summaryTypes, 
	String^ weightField, 
	CancellationToken cancellationToken
)
member SummaryAsync : 
        field : string * 
        summaryTypes : AFSummaryTypes * 
        weightField : string * 
        cancellationToken : CancellationToken -> Task<AFSummaryResult> 

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: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in