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

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

Public Function ReplaceValuesAsync ( 
	timeRange As AFTimeRange,
	values As IList(Of AFValue),
	bufferOption As AFBufferOption,
	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 bufferOption As AFBufferOption
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFErrors(Of AFValue))

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

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

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

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for removal and replacement of data.

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.

bufferOption

Type: OSIsoft.AF.DataAFBufferOption
An enumeration value that specifies buffering option.

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.

For successful data write through Buffer, this method requires that PI Buffer Subsystem (PIBufSS) needs to be correctly pre-configured with Buffering Manager. Currently, buffering data through PIBufSS has a limitation where error feedback from PI Data Archive cannot be returned to the caller.

Data write through Buffer will be fanned to Collective members.

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