AFSearch.Summary Method (String, AFSummaryTypes, String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Summarizes the result of this search with the specified weighting.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFSummaryResult Summary( string field, AFSummaryTypes summaryTypes, string weightField )
Public Function Summary ( field As String, summaryTypes As AFSummaryTypes, weightField As String ) As AFSummaryResult Dim instance As AFSearch Dim field As String Dim summaryTypes As AFSummaryTypes Dim weightField As String Dim returnValue As AFSummaryResult returnValue = instance.Summary(field, summaryTypes, weightField)
public: AFSummaryResult^ Summary( String^ field, AFSummaryTypes summaryTypes, String^ weightField )
member Summary : field : string * summaryTypes : AFSummaryTypes * weightField : string -> 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.
Return Value
Type: AFSummaryResultA result containing the requested summaries or an error if the summaries could not be performed.