AF SDK Reference

AFNotificationRule.GetStatus Method (IList(AFNotificationRule))

Save PDF

TABLE OF CONTENTS

AFNotificationRule.GetStatus Method (IList(AFNotificationRule))

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Get the status for the list of specified AFNotificationRule from the PI AF Server.

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

Syntax

public static AFErrors<AFNotificationRule> GetStatus(
	IList<AFNotificationRule> notificationRules
)

Public Shared Function GetStatus ( 
	notificationRules As IList(Of AFNotificationRule)
) As AFErrors(Of AFNotificationRule)

Dim notificationRules As IList(Of AFNotificationRule)
Dim returnValue As AFErrors(Of AFNotificationRule)

returnValue = AFNotificationRule.GetStatus(notificationRules)

public:
static AFErrors<AFNotificationRule^>^ GetStatus(
	IList<AFNotificationRule^>^ notificationRules
)

static member GetStatus : 
        notificationRules : IList<AFNotificationRule> -> AFErrors<AFNotificationRule>

Parameters

notificationRules: Type: System.Collections.GenericIListAFNotificationRule
The list of AFNotificationRule to have their Status read from the PI AF Server.

Return Value

Type: AFErrorsAFNotificationRule
An AFErrorsTKey object containing any AFNotificationRule that generated errors. Returns if no errors.

Remarks

This method will get the status for all the AFNotificationRule in the list in a single call to the PI AF Server. This is more efficient than refreshing each AFNotificationRule and then getting its Status property. When this method returns, each AFNotificationRule in the list will have its Status property updated with the value read from the server but no other properties of the AFNotificationRule 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