AF SDK Reference

PIDataPipe.AddSignupsWithInitEvents Method

Save PDF

PIDataPipe.AddSignupsWithInitEvents Method

Save PDF

Last UpdatedNov 18, 2025
3 minute read

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

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

Syntax

public AFListResults<PIPoint, AFDataPipeEvent> AddSignupsWithInitEvents(
	IList<PIPoint> pointList
)

Public Function AddSignupsWithInitEvents ( 
	pointList As IList(Of PIPoint)
) As AFListResults(Of PIPoint, AFDataPipeEvent)

Dim instance As PIDataPipe
Dim pointList As IList(Of PIPoint)
Dim returnValue As AFListResults(Of PIPoint, AFDataPipeEvent)

returnValue = instance.AddSignupsWithInitEvents(pointList)

public:
AFListResults<PIPoint^, AFDataPipeEvent^>^ AddSignupsWithInitEvents(
	IList<PIPoint^>^ pointList
)

member AddSignupsWithInitEvents : 
        pointList : IList<PIPoint> -> AFListResults<PIPoint, AFDataPipeEvent>

Parameters

pointList: Type: System.Collections.GenericIListPIPoint
List of PIPoint objects to be added to the pipe.

Return Value

Type: AFListResultsPIPoint, AFDataPipeEvent
A list of initial AFDataPipeEvent for the new signup list of PIPoint objects. Any errors during the call are added to the error collection of the AFListResultsTKey, TResult.

Remarks

This method is the same as AddSignups(IListPIPoint) except that the initial events for the signup list are returned by the method. The initial events are useful for applications like data cache or calculations using multiple inputs. This method is only supported by AFDataPipeType of TimeSeries. Note that there are normally two initial events returned by the server for each signup point: the last archived event and the current snapshot event. If there is no last archived event, the server will only return snapshot event as initial event for the point. If there is no archive event and no snapshot event (they have been explicitly deleted), the server will not return any initial events for the point. The application must handle these three different cases and cannot assume a fixed number of initial events.

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