Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PIDataPipe Methods

  • Last UpdatedNov 18, 2025
  • 3 minute read
PIDataPipe Methods

The PIDataPipe type exposes the following members.

Methods

  NameDescription
Public method
AddSignups
Adds a list of PIPoint objects to be monitored by the data pipe. The method returns server level and point level errors in AFErrorsTKey .
Public method
AddSignupsWithInitEvents
Adds a list of PIPoint objects to be monitored by the data pipe and returns the initial events for this list of new signup objects. PIserver level and point level errors can be accessed in the AFListResultsTKey, TResult
Public method
AsReadOnly
Returns a read only list of PIPoint objects currently monitored by the data pipe.
Public method
Close
Terminates the data pipe's connection to the PIServers associated with the monitored PIPoint objects.
Public method
Dispose
Terminates the data pipe's connection to the PIServers associated with the monitored PIPoint objects. This method also releases the resources used by the PIDataPipe. Calling any method after the object has been disposed will result in an exception being thrown.
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method
GetObserverEvents
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.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
GetUpdateEvents
Retrieves new events that occurred on the PIPoint objects monitored by the data pipe.
Public method
ListSignUpsByServer
Return a list of PIPoint objects monitored by the data pipe for the requested PIServer.
Public method
RemoveSignups
Remove a list of PIPoint objects being monitored by the data pipe. The method returns server level and point level errors in AFErrorsTKey .
Public method
Subscribe
Register an IObserver for AFDataPipeEvent with the PIDataPipe. All the AFDataPipeEvents received by the data pipe will be sent to the IObserver.
Public method
ToString
Returns a string that represents the current object.
(Inherited from Object.)

See Also

TitleResults for “How to create a CRG?”Also Available in