PIPoint.PlotValuesAsync Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[HandleProcessCorruptedStateExceptionsAttribute] public Task<AFValues> PlotValuesAsync( AFTimeRange timeRange, int intervals, CancellationToken cancellationToken = default )
<HandleProcessCorruptedStateExceptionsAttribute> Public Function PlotValuesAsync ( timeRange As AFTimeRange, intervals As Integer, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of AFValues) Dim instance As PIPoint Dim timeRange As AFTimeRange Dim intervals As Integer Dim cancellationToken As CancellationToken Dim returnValue As Task(Of AFValues) returnValue = instance.PlotValuesAsync(timeRange, intervals, cancellationToken)
public: [HandleProcessCorruptedStateExceptionsAttribute] Task<AFValues^>^ PlotValuesAsync( AFTimeRange timeRange, int intervals, CancellationToken cancellationToken = CancellationToken() )
[<HandleProcessCorruptedStateExceptionsAttribute>] member PlotValuesAsync : timeRange : AFTimeRange * intervals : int * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken new CancellationToken() *) -> Task<AFValues>
Parameters
- timeRange
- Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for the plot values request. - intervals
- Type: SystemInt32
The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. - 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 values that will produce the most accurate plot over the time range while minimizing the amount of data returned.
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. |