PIPointList.InterpolatedValueAsync Method
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
Returns an AFListResults<TKey, TResult> containing a list of AFValue objects
corresponding to the interpolated value for the PIPoint objects in the list
for the requested time.
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.0.1156
Syntax
public Task<AFListResults<PIPoint, AFValue>> InterpolatedValueAsync( AFTime requestedTime, CancellationToken cancellationToken = default )
Public Function InterpolatedValueAsync ( requestedTime As AFTime, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of AFListResults(Of PIPoint, AFValue)) Dim instance As PIPointList Dim requestedTime As AFTime Dim cancellationToken As CancellationToken Dim returnValue As Task(Of AFListResults(Of PIPoint, AFValue)) returnValue = instance.InterpolatedValueAsync(requestedTime, cancellationToken)
public: Task<AFListResults<PIPoint^, AFValue^>^>^ InterpolatedValueAsync( AFTime requestedTime, CancellationToken cancellationToken = CancellationToken() )
member InterpolatedValueAsync : requestedTime : AFTime * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken new CancellationToken() *) -> Task<AFListResults<PIPoint, AFValue>>
Parameters
- requestedTime
- Type: OSIsoft.AF.Time.AFTime
The time at which the value is desired. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
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: Task<AFListResults<PIPoint, AFValue>>Returns a task whose result is an AFListResults<TKey, TResult> list containing an interpolated 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 AFListResults<TKey, 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
 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. |