AFDataPipe.GetUpdateEvents Method (Boolean)
- Last UpdatedJan 12, 2026
- 2 minute read
- PI System
- AF SDK 3.2.0
- Developer
Get the list of data change events from the server
Namespace: OSIsoft.AF.Data
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.2.0.7
Syntax
public AFListResults<AFAttribute, AFDataPipeEvent> GetUpdateEvents( out bool hasMoreEvents )
Public Function GetUpdateEvents ( <OutAttribute> ByRef hasMoreEvents As Boolean ) As AFListResults(Of AFAttribute, AFDataPipeEvent) Dim instance As AFDataPipe Dim hasMoreEvents As Boolean Dim returnValue As AFListResults(Of AFAttribute, AFDataPipeEvent) returnValue = instance.GetUpdateEvents(hasMoreEvents)
public: AFListResults<AFAttribute^, AFDataPipeEvent^>^ GetUpdateEvents( [OutAttribute] bool% hasMoreEvents )
member GetUpdateEvents : hasMoreEvents : bool byref -> AFListResults<AFAttribute, AFDataPipeEvent>
Parameters
- hasMoreEvents
- Type: SystemBoolean
Indicates whether there could be more events in the pipe. hasMoreEvent is set to true whenever any of the data source still have events to be retrieved.
Return Value
Type: AFListResultsAFAttribute, 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 there are IObservers registered with the data pipe.
Use the GetObserverEvents method to trigger event retrieval if IObserver is registered with the data pipe.