AFAnalysis.FindAnalyses Method (AFObject, AFSortField, AFSortOrder, Int32, Int32, Int32)
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Note: This API is now obsolete.
Performs a paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects with the specified target.
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 the 'AFAnalysisSearch' class using the 'Target' filter.")] public static AFNamedCollectionList<AFAnalysis> FindAnalyses( AFObject target, AFSortField sortField, AFSortOrder sortOrder, int startIndex, int maxCount, out int totalCount )
<BrowsableAttribute(false)> <ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Target' filter.")> Public Shared Function FindAnalyses ( target As AFObject, sortField As AFSortField, sortOrder As AFSortOrder, startIndex As Integer, maxCount As Integer, <OutAttribute> ByRef totalCount As Integer ) As AFNamedCollectionList(Of AFAnalysis) Dim target As AFObject Dim sortField As AFSortField Dim sortOrder As AFSortOrder Dim startIndex As Integer Dim maxCount As Integer Dim totalCount As Integer Dim returnValue As AFNamedCollectionList(Of AFAnalysis) returnValue = AFAnalysis.FindAnalyses(target, sortField, sortOrder, startIndex, maxCount, totalCount)
public: [BrowsableAttribute(false)] [ObsoleteAttribute(L"This method has been replaced by the 'AFAnalysisSearch' class using the 'Target' filter.")] static AFNamedCollectionList<AFAnalysis^>^ FindAnalyses( AFObject^ target, AFSortField sortField, AFSortOrder sortOrder, int startIndex, int maxCount, [OutAttribute] int% totalCount )
[<BrowsableAttribute(false)>] [<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Target' filter.")>] static member FindAnalyses : target : AFObject * sortField : AFSortField * sortOrder : AFSortOrder * startIndex : int * maxCount : int * totalCount : int byref -> AFNamedCollectionList<AFAnalysis>
Parameters
- target
- Type: OSIsoft.AFAFObject
The specified target object to match. - sortField
- Type: OSIsoft.AFAFSortField
The field or property of the object used to sort the returned collection. This value should not be changed between calls when attempting to get the next page of items. - sortOrder
- Type: OSIsoft.AFAFSortOrder
The order that the returned collection is sorted. This value should not be changed between calls when attempting to get the next page of items. - startIndex
- Type: SystemInt32
The starting index (zero based) of the items to be returned. - maxCount
- Type: SystemInt32
The maximum number of objects to be returned per call (the page size). - totalCount
- Type: SystemInt32
The total number of objects that match the search criteria.
Return Value
Type: AFNamedCollectionListAFAnalysisReturns the collection containing the specified page of AFAnalysis objects which match the specified target.
Remarks
This search returns all the AFAnalysis objects where its Target equals the specified target. This method will make a call to the server every time it is called and will update the cached Analyses collection of the target if the target is an AFElement.
| Consider using the new AFAnalysisSearch class for finding analyses instead of using this method. |
Version Information
AFSDK
Supported in: 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4Obsolete (compiler warning) in 3.1.1
Obsolete (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