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

AF SDK Reference

AFNotificationRule.Status Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFNotificationRule.Status Property
The current notification rule status.

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

Syntax

public AFStatus Status { get; }
Public ReadOnly Property Status As AFStatus
	Get

Dim instance As AFNotificationRule
Dim value As AFStatus

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

Property Value

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

Remarks

If the analysis is created from an AFNotificationRuleTemplate, 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.

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 notification rule. Use the SetStatus(AFStatus) method to set the status of the notification rule.

When created from a template, this property will initially be set to Enabled if the CreateEnabled property is set to and Disabled when . If not created from a template, the value will initially be Disabled.

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

See Also

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