AFNotification.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; set; }
Public Property Status As AFStatus Get Set Dim instance As AFNotification 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: AFStatusReturns the current notification status.
Remarks
Changing the notification status using this property will not set the value in the PI AF Server immediately like the SetStatus(AFStatus, String) method. When using this property to set the status, the notification must be checked in to save the change to the server. Calling the SetStatus(AFStatus, String) method is more efficient since it does not require the notification to be checked out or checked in.
The ErrorMessage property is normally set to the reason that the notification was set to an error status.
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.
| When setting the Status or the ErrorMessage, it is more efficient to call the SetStatus(AFStatus, String) method to reduce the number of calls to the PI AF Server. |