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

AF SDK Reference

AFElement.GetAnalyses Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFElement.GetAnalyses Method

Note: This API is now obsolete.

Retrieves a collection of AFAnalysis objects that target this element.

Namespace:  OSIsoft.AF.Asset
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 AFNamedCollectionList<AFAnalysis> GetAnalyses(
	AFSortField sortField,
	AFSortOrder sortOrder,
	int maxCount
)
<BrowsableAttribute(false)>
<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Target' filter.")>
Public Function GetAnalyses ( 
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	maxCount As Integer
) As AFNamedCollectionList(Of AFAnalysis)

Dim instance As AFElement
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim maxCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFAnalysis)

returnValue = instance.GetAnalyses(sortField, 
	sortOrder, maxCount)
public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"This method has been replaced by the 'AFAnalysisSearch' class using the 'Target' filter.")]
AFNamedCollectionList<AFAnalysis^>^ GetAnalyses(
	AFSortField sortField, 
	AFSortOrder sortOrder, 
	int maxCount
)
[<BrowsableAttribute(false)>]
[<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Target' filter.")>]
member GetAnalyses : 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        maxCount : int -> AFNamedCollectionList<AFAnalysis> 

Parameters

sortField
Type: OSIsoft.AFAFSortField
The field or property of the object used to sort the returned collection.
sortOrder
Type: OSIsoft.AFAFSortOrder
The order that the returned collection is sorted.
maxCount
Type: SystemInt32
The maximum number of objects to be returned.

Return Value

Type: AFNamedCollectionListAFAnalysis
Returns a collection of AFAnalysis objects that target this element.

Remarks

This method will return the AFAnalysis objects that have their Target set to this element. This method will make a call to the server every time it is called and will update the cached Analyses collection for this element.

Using the Analyses collection is more efficient to using this method because it is cached. Calling this method will refresh the Analyses collection.

Version Information

AFSDK

Supported in: 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
Obsolete (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

See Also

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