AF SDK Reference

PIPointList.EndOfStreamAsync Method

Save PDF

PIPointList.EndOfStreamAsync Method

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Returns an AFListResultsTKey, TResult containing a list of AFValue objects corresponding to the end of stream value for the PIPoint objects in the list. The order of the AFValue objects in the return list is the same order as the corresponding PIPoint in the PIPointList.

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

Syntax

public Task<AFListResults<PIPoint, AFValue>> EndOfStreamAsync(
	CancellationToken cancellationToken = default
)

Public Function EndOfStreamAsync ( 
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFListResults(Of PIPoint, AFValue))

Dim instance As PIPointList
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFListResults(Of PIPoint, AFValue))

returnValue = instance.EndOfStreamAsync(cancellationToken)

public:
Task<AFListResults<PIPoint^, AFValue^>^>^ EndOfStreamAsync(
	CancellationToken cancellationToken = CancellationToken()
)

member EndOfStreamAsync : 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<AFListResults<PIPoint, AFValue>>

Parameters

cancellationToken (Optional): Type: System.ThreadingCancellationToken
A cancellation token used to abort processing before completion. Passing the default CancellationToken.None will run to completion or until the PIConnectionInfo.OperationTimeOut period elapses.

Return Value

Type: TaskAFListResultsPIPoint, AFValue
Returns a task whose result is an AFListResultsTKey, TResult list containing the end of stream value for each PIPoint object in the PointList. If any point level or server level errors occur, they are added to the corresponding error collections in the AFListResultsTKey, TResult

Exceptions

Exception	Condition
AggregateException	Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.
NotSupportedException	PI Server versions before 3.4.375 do not support list methods.

Remarks

The end of stream is the value with the largest or newest timestamp.

Important
Impersonation of AF SDK asynchronous calls relies on the .NET framework's built-in support for flowing execution context across asynchronous points. When making these calls while impersonating, the thread or runtime must be configured to propagate the impersonation across these asynchronous points (see the SecurityContext documentation for details).

Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

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

AF SDK Reference