AF SDK Reference

PIDataPipe.GetObserverEvents Method

Save PDF

PIDataPipe.GetObserverEvents Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Trigger retrieval of new events that occurred on the PIPoint objects monitored by the data pipe. The new events will be sent to the IObserver objects registered with the data pipe.

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

Syntax

public AFErrors<PIPoint> GetObserverEvents(
	int maxEventCountPerServer,
	out bool hasMoreEvents
)

Public Function GetObserverEvents ( 
	maxEventCountPerServer As Integer,
	<OutAttribute> ByRef hasMoreEvents As Boolean
) As AFErrors(Of PIPoint)

Dim instance As PIDataPipe
Dim maxEventCountPerServer As Integer
Dim hasMoreEvents As Boolean
Dim returnValue As AFErrors(Of PIPoint)

returnValue = instance.GetObserverEvents(maxEventCountPerServer, 
	hasMoreEvents)

public:
AFErrors<PIPoint^>^ GetObserverEvents(
	int maxEventCountPerServer, 
	[OutAttribute] bool% hasMoreEvents
)

member GetObserverEvents : 
        maxEventCountPerServer : int * 
        hasMoreEvents : bool byref -> AFErrors<PIPoint>

Parameters

maxEventCountPerServer: Type: SystemInt32
The maximum number of events to retrieve from each PIServer.
hasMoreEvents: Type: SystemBoolean
Indicates whether there could be more events in the pipe. hasMoreEvents is set to true whenever the number of result events reach maxEventCountPerServer for any one PI Data Archive within the pipe.

Return Value

Type: AFErrorsPIPoint
A collection of AFErrorsTKey if any error occurred or , if there were not any errors.

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, 2.7.5, 2.7, 2.6

AF SDK Reference