PIPoint.InterpolatedValuesByCountAsync Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public Task<AFValues> InterpolatedValuesByCountAsync( AFTimeRange timeRange, int numberOfValues, string filterExpression, bool includeFilteredValues, CancellationToken cancellationToken = default )
Public Function InterpolatedValuesByCountAsync ( timeRange As AFTimeRange, numberOfValues As Integer, filterExpression As String, includeFilteredValues As Boolean, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of AFValues) Dim instance As PIPoint Dim timeRange As AFTimeRange Dim numberOfValues As Integer Dim filterExpression As String Dim includeFilteredValues As Boolean Dim cancellationToken As CancellationToken Dim returnValue As Task(Of AFValues) returnValue = instance.InterpolatedValuesByCountAsync(timeRange, numberOfValues, filterExpression, includeFilteredValues, cancellationToken)
public: Task<AFValues^>^ InterpolatedValuesByCountAsync( AFTimeRange timeRange, int numberOfValues, String^ filterExpression, bool includeFilteredValues, CancellationToken cancellationToken = CancellationToken() )
member InterpolatedValuesByCountAsync : timeRange : AFTimeRange * numberOfValues : int * filterExpression : string * includeFilteredValues : bool * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken new CancellationToken() *) -> Task<AFValues>
Parameters
- timeRange
- Type: OSIsoft.AF.TimeAFTimeRange
The start and end time covered by the request. - numberOfValues
- Type: SystemInt32
The number of interpolated values to return even spaced throughout the timeRange. - filterExpression
- Type: SystemString
A filter expression that follows the performance equation syntax. - includeFilteredValues
- Type: SystemBoolean
Specify to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a "Filtered" enumeration value with bad status. Repeated consecutive failures are omitted. - 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: TaskAFValuesReturns a task whose result is an AFValues collection with the interpolated values.
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. |