Click or drag to resize
OSIsoft, LLC

PIPointRecordedValueAsync Method

Returns a single recorded AFValue based on the passed time and mode.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public Task<AFValue> RecordedValueAsync(
	AFTime time,
	AFRetrievalMode mode = AFRetrievalMode.Auto,
	CancellationToken cancellationToken = null


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: TaskAFValue
Returns 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.
AggregateException Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.

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


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8
See Also
Enabling Operational Intelligence