AFAnalysisSearch.FindAnalyses Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Note: This API is now obsolete.
This method will return the AFAnalysis objects that match the
search tokens.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[BrowsableAttribute(false)] [ObsoleteAttribute("This method has been replaced by FindObjects.")] public IEnumerable<AFAnalysis> FindAnalyses( int startIndex = 0, bool fullLoad = false, int pageSize = 0 )
<BrowsableAttribute(false)> <ObsoleteAttribute("This method has been replaced by FindObjects.")> Public Function FindAnalyses ( Optional startIndex As Integer = 0, Optional fullLoad As Boolean = false, Optional pageSize As Integer = 0 ) As IEnumerable(Of AFAnalysis) Dim instance As AFAnalysisSearch Dim startIndex As Integer Dim fullLoad As Boolean Dim pageSize As Integer Dim returnValue As IEnumerable(Of AFAnalysis) returnValue = instance.FindAnalyses(startIndex, fullLoad, pageSize)
public: [BrowsableAttribute(false)] [ObsoleteAttribute(L"This method has been replaced by FindObjects.")] IEnumerable<AFAnalysis^>^ FindAnalyses( int startIndex = 0, bool fullLoad = false, int pageSize = 0 )
[<BrowsableAttribute(false)>] [<ObsoleteAttribute("This method has been replaced by FindObjects.")>] member FindAnalyses : ?startIndex : int * ?fullLoad : bool * ?pageSize : int (* Defaults: let _startIndex = defaultArg startIndex 0 let _fullLoad = defaultArg fullLoad false let _pageSize = defaultArg pageSize 0 *) -> IEnumerable<AFAnalysis>
Parameters
- startIndex (Optional)
- Type: SystemInt32
The starting index (zero based) of the items to be returned. - fullLoad (Optional)
- Type: SystemBoolean
If , then the returned objects will be full loaded. If , then the returned objects may not be fully loaded and will require another call to the server if additional information about the object is requested that is not already loaded. - pageSize (Optional)
- Type: SystemInt32
The page size used for retrieving objects from the server. If this parameter is less than or equal to zero, then the page size will be set to the current value of the CollectionPageSize setting.
Return Value
Type: IEnumerableAFAnalysisReturns an enumerable list of the analyses found using the search tokens for this search object.
Exceptions
| Exception | Condition |
|---|---|
| FormatException | This exception is thrown if the ThrowOnError property is and there is a format error in the search query. |
| NotSupportedException | This exception is thrown if the ThrowOnError property is and one of the filters is not supported or the query is too complex to be evaluated by the server. |
Version Information
AFSDK
Supported in: 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5Obsolete (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