PIPoint.EndOfStreamAsync Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
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: TaskAFValueReturns a task whose result is the latest AFValue for the PI Point.
Exceptions
| Exception | Condition |
|---|---|
| AggregateException | Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure. |
Remarks
| 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). |
| 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. |