PIPoint.RecordedValueAsync Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Returns a single recorded AFValue based on the
passed time and mode.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public Task<AFValue> RecordedValueAsync( AFTime time, AFRetrievalMode mode = AFRetrievalMode.Auto, CancellationToken cancellationToken = default )
Public Function RecordedValueAsync ( time As AFTime, Optional mode As AFRetrievalMode = AFRetrievalMode.Auto, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of AFValue) Dim instance As PIPoint Dim time As AFTime Dim mode As AFRetrievalMode Dim cancellationToken As CancellationToken Dim returnValue As Task(Of AFValue) returnValue = instance.RecordedValueAsync(time, mode, cancellationToken)
public: Task<AFValue^>^ RecordedValueAsync( AFTime time, AFRetrievalMode mode = AFRetrievalMode::Auto, CancellationToken cancellationToken = CancellationToken() )
member RecordedValueAsync : time : AFTime * ?mode : AFRetrievalMode * ?cancellationToken : CancellationToken (* Defaults: let _mode = defaultArg mode AFRetrievalMode.Auto let _cancellationToken = defaultArg cancellationToken new CancellationToken() *) -> Task<AFValue>
Parameters
- time
- Type: OSIsoft.AF.TimeAFTime
The time at which the value is desired. - mode (Optional)
- Type: OSIsoft.AF.DataAFRetrievalMode
The mode is used to determine the value to return when a value does not exist at the exact time specified. The value is taken from the AFRetrievalMode enumeration. - 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 an AFValue with the recorded value for the PI point. The time stamp of the value will indicate the time of the recorded event.
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. |