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

AF SDK Reference

AFAnalysis.GetStatus Method (IList(AFAnalysis))

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAnalysis.GetStatus Method (IList(AFAnalysis))
Get the status for the list of specified analyses from the PI AF Server.

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public static void GetStatus(
	IList<AFAnalysis> analyses
)
Public Shared Sub GetStatus ( 
	analyses As IList(Of AFAnalysis)
)

Dim analyses As IList(Of AFAnalysis)

AFAnalysis.GetStatus(analyses)
public:
static void GetStatus(
	IList<AFAnalysis^>^ analyses
)
static member GetStatus : 
        analyses : IList<AFAnalysis> -> unit 

Parameters

analyses
Type: System.Collections.GenericIListAFAnalysis
The list of analyses to have their Status read from the PI AF Server.

Remarks

This method will get the status for all the analyses in the list in a single call to the PI AF Server. This is more efficient than refreshing each analysis and then getting its Status property. When this method returns, each analysis in the list will have its Status property updated with the value read from the server but no other properties of the analysis will be updated.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

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