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

AF SDK Reference

PIPoint.EndOfStreamAsync Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
PIPoint.EndOfStreamAsync Method
Gets the value recorded for a PI Point with the latest time stamp. This value may be in the future.

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

Syntax

public Task<AFValue> EndOfStreamAsync(
	CancellationToken cancellationToken = default
)
Public Function EndOfStreamAsync ( 
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFValue)

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

returnValue = instance.EndOfStreamAsync(cancellationToken)
public:
Task<AFValue^>^ EndOfStreamAsync(
	CancellationToken cancellationToken = CancellationToken()
)
member EndOfStreamAsync : 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<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: TaskAFValue
Returns a task whose result is the latest AFValue for the PI Point.

Exceptions

ExceptionCondition
AggregateException Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.

Remarks

Important note 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).

Note 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

See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in