AFAnalysis.GetResults Method (AFSearchMode, Object, Object, Double, AFAttribute, UOM)
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Note: This API is now obsolete.
Use this method to get all the stored results for the attribute
of cases of the analysis based upon the specified search criteria.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[BrowsableAttribute(false)] [ObsoleteAttribute("This Method has been replaced by 'GetResults()' that accepts a 'maxCount' parameter.")] public AFValues GetResults( AFSearchMode searchMode, Object startTime, Object endTime, double maxCaseDuration, AFAttribute attribute, UOM desiredUOM )
<BrowsableAttribute(false)> <ObsoleteAttribute("This Method has been replaced by 'GetResults()' that accepts a 'maxCount' parameter.")> Public Function GetResults ( searchMode As AFSearchMode, startTime As Object, endTime As Object, maxCaseDuration As Double, attribute As AFAttribute, desiredUOM As UOM ) As AFValues Dim instance As AFAnalysis Dim searchMode As AFSearchMode Dim startTime As Object Dim endTime As Object Dim maxCaseDuration As Double Dim attribute As AFAttribute Dim desiredUOM As UOM Dim returnValue As AFValues returnValue = instance.GetResults(searchMode, startTime, endTime, maxCaseDuration, attribute, desiredUOM)
public: [BrowsableAttribute(false)] [ObsoleteAttribute(L"This Method has been replaced by 'GetResults()' that accepts a 'maxCount' parameter.")] AFValues^ GetResults( AFSearchMode searchMode, Object^ startTime, Object^ endTime, double maxCaseDuration, AFAttribute^ attribute, UOM^ desiredUOM )
[<BrowsableAttribute(false)>] [<ObsoleteAttribute("This Method has been replaced by 'GetResults()' that accepts a 'maxCount' parameter.")>] member GetResults : searchMode : AFSearchMode * startTime : Object * endTime : Object * maxCaseDuration : float * attribute : AFAttribute * desiredUOM : UOM -> AFValues
Parameters
- searchMode
- Type: OSIsoft.AF.AssetAFSearchMode
Determines how the startTime and endTime parameters are treated when searching for case objects to be included in the returned collection. - startTime
- Type: SystemObject
An object representing the earliest starting time for the cases to be returned. The value may be an AFTime, DateTime, PITime, String, or numeric. A DateTime (or a DATE will be treated as UTC time if its Kind property is set to Unspecified. Because DATE values from COM or VB6 clients are marshalled as Unspecified, these client applications must convert to UTC prior to marshalling. An integer numeric represents the number of ticks (100-nanosecond intervals) since January 1, 0001. A floating point numeric represents the number of seconds since January 1, 1970 UTC. A String is interpreted as local time, unless it contains a time zone indicator such as a trailing "Z" or "GMT". Strings will be interpreted with the AFTime.Parse Overload methods so that relative formats with intervals ("*", "T+3h", etc.) are also supported. Relative time intervals are based on the object's QueryDate. - endTime
- Type: SystemObject
An object representing the latest ending time for the cases to be returned. When the specified startTime is earlier than the endTime, the items in the resulting list will be indexed in time ascending direction. If the startTime is more recent than the endTime, the items in the resulting list will be indexed in time descending direction. The value may be an AFTime, DateTime, PITime, String, or numeric. A DateTime (or a DATE will be treated as UTC time if its Kind property is set to Unspecified. Because DATE values from COM or VB6 clients are marshalled as Unspecified, these client applications must convert to UTC prior to marshalling. An integer numeric represents the number of ticks (100-nanosecond intervals) since January 1, 0001. A floating point numeric represents the number of seconds since January 1, 1970 UTC. A String is interpreted as local time, unless it contains a time zone indicator such as a trailing "Z" or "GMT". Strings will be interpreted with the AFTime.Parse Overload methods so that relative formats with intervals ("*", "T+3h", etc.) are also supported. Relative time intervals are based on the object's QueryDate. - maxCaseDuration
- Type: SystemDouble
This parameter is ignored. - attribute
- Type: OSIsoft.AF.AssetAFAttribute
The AFAttribute to returned stored results for. - desiredUOM
- Type: OSIsoft.AF.UnitsOfMeasureUOM
The desired unit of measure for the returned values. If , then the value is returned in the unit of measure specified by the DefaultUOM property.
Return Value
Type: AFValuesReturns the collection of attribute results values based upon the specified startTime and endTime parameters.
Remarks
This method is obsolete and has been replaced by the
GetResults
method that accepts a 'maxCount' parameter.
Version Information
AFSDK
Obsolete (compiler warning) in 3.1.1Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5
Obsolete (compiler warning) in 2.10.0
Obsolete (compiler warning) in 2.10
Obsolete (compiler warning) in 2.9.5
Obsolete (compiler warning) in 2.9
Obsolete (compiler warning) in 2.8.5
Obsolete (compiler warning) in 2.8
Obsolete (compiler warning) in 2.7.5
Obsolete (compiler warning) in 2.7
Obsolete (compiler warning) in 2.6
Obsolete (compiler warning) in 2.5
Obsolete (compiler warning) in 2.4