PIPoint.ReplaceValuesAsync Method (AFTimeRange, IList(AFValue), CancellationToken)

public Task<AFErrors<AFValue>> ReplaceValuesAsync(
	AFTimeRange timeRange,
	IList<AFValue> values,
	CancellationToken cancellationToken = default
)

Public Function ReplaceValuesAsync ( 
	timeRange As AFTimeRange,
	values As IList(Of AFValue),
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFErrors(Of AFValue))

Dim instance As PIPoint
Dim timeRange As AFTimeRange
Dim values As IList(Of AFValue)
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFErrors(Of AFValue))

returnValue = instance.ReplaceValuesAsync(timeRange, 
	values, cancellationToken)

public:
Task<AFErrors<AFValue^>^>^ ReplaceValuesAsync(
	AFTimeRange timeRange, 
	IList<AFValue^>^ values, 
	CancellationToken cancellationToken = CancellationToken()
)

member ReplaceValuesAsync : 
        timeRange : AFTimeRange * 
        values : IList<AFValue> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<AFErrors<AFValue>> 

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for replacement of the existing values.

values

Type: System.Collections.GenericIListAFValue
The list of replacement values with an associated PIPoint for each value. If an empty list then existing data within the specified AFTimeRange will be deleted. The time stamp of AFValue in values must be within the specified AFTimeRange.

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

This method requires PI Data Archive 2016 or later that supports DeleteRange feature. This is indicated by Supports(PIServerFeature) check returning for the case of DeleteRange.

If not specified in AFSDK.config, the AFBufferOption is defaulted to BufferIfPossible. The default buffering option for the current AF SDK client instance can be modified via the static property AFData.BufferOption.

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.

AFSDK

Reference