AF SDK Reference

AFNotificationRule.GetStatus Method

Save PDF

TABLE OF CONTENTS

AFNotificationRule.GetStatus Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Get the Status property immediately from the PI AF Server.

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

Syntax

public AFStatus GetStatus()

Public Function GetStatus As AFStatus

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

AF SDK Reference