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

AF SDK Reference

AFAnalysis.Status Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAnalysis.Status Property
The current analysis status.

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

Syntax

public AFStatus Status { get; set; }
Public Property Status As AFStatus
	Get
	Set

Dim instance As AFAnalysis
Dim value As AFStatus

value = instance.Status

instance.Status = value
public:
property AFStatus Status {
	AFStatus get ();
	void set (AFStatus value);
}
member Status : AFStatus with get, set

Property Value

Type: AFStatus
Returns the current analysis status. The default value is Disabled unless created from an AFAnalysisTemplate. When created from a template, the default value is determined by the template's CreateEnabled setting.

Remarks

If the analysis is created from an AFAnalysisTemplate, the initial value of this property will be Enabled if the template's CreateEnabled property is . If it is , then the initial value of this property will be Disabled.

Changing the analysis status using this property will not set the value in the PI AF Server immediately like the SetStatus(AFStatus) method. When using this property to set the status, the analysis must be checked in to save the change to the server. Calling the SetStatus(AFStatus) method is more efficient since it does not require the analysis to be checked out or checked in.

This property will return the cached status that was last read from the PI AF Server. The GetStatus method can be used to get the current status from the PI AF Server without modifying any other properties of the analysis.

Important note Important
When setting the Status, it is more efficient to call the SetStatus(AFStatus) method to reduce the number of calls to the PI AF Server.

Version Information

AFSDK


See Also

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