PIDataPipe.GetUpdateEvents Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Retrieves new events that occurred on the PIPoint objects monitored by the data pipe.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFListResults<PIPoint, AFDataPipeEvent> GetUpdateEvents( int maxEventCountPerServer )
Public Function GetUpdateEvents ( maxEventCountPerServer As Integer ) As AFListResults(Of PIPoint, AFDataPipeEvent) Dim instance As PIDataPipe Dim maxEventCountPerServer As Integer Dim returnValue As AFListResults(Of PIPoint, AFDataPipeEvent) returnValue = instance.GetUpdateEvents(maxEventCountPerServer)
public: AFListResults<PIPoint^, AFDataPipeEvent^>^ GetUpdateEvents( int maxEventCountPerServer )
member GetUpdateEvents : maxEventCountPerServer : int -> AFListResults<PIPoint, AFDataPipeEvent>
Parameters
- maxEventCountPerServer
- Type: SystemInt32
The maximum number of events to retrieve from each PIServer.
Return Value
Type: AFListResultsPIPoint, AFDataPipeEventAn AFListResultsTKey, TResult instance containing a list of AFDataPipeEvent objects and any errors that occurred associated with their corresponding PIServer that the error occurred on.
Remarks
This method could throw InvalidOperationException if the data pipe already has IObserver registered.
If the application registers IObserver with the data pipe, use the GetObserverEvents(Int32, Boolean) method
to trigger event notification.