AF SDK Reference

AFAnalysis.GetStatus Method

Save PDF

TABLE OF CONTENTS

AFAnalysis.GetStatus Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Get the analysis Status property immediately from the PI AF Server.

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

Syntax

public AFStatus GetStatus()

Public Function GetStatus As AFStatus

Dim instance As AFAnalysis
Dim returnValue As AFStatus

returnValue = instance.GetStatus()

public:
AFStatus GetStatus()

member GetStatus : unit -> AFStatus

Return Value

Type: AFStatus
Returns the status read from the PI AF Server.

Remarks

Getting the analysis Status using this method gets the value from the PI AF Server immediately and does not require the analysis to be refreshed and does not update any other properties of the analysis. Only the Status property 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

AF SDK Reference