AFNotificationRule.Status Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
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: AFStatusReturns 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.