PIServer.UpdateValuesAsync Method (IList(AFValue), AFUpdateOption, AFBufferOption, CancellationToken)

public Task<AFErrors<AFValue>> UpdateValuesAsync(
	IList<AFValue> values,
	AFUpdateOption option,
	AFBufferOption bufferOption,
	CancellationToken cancellationToken = default
)

Public Function UpdateValuesAsync ( 
	values As IList(Of AFValue),
	option As AFUpdateOption,
	bufferOption As AFBufferOption,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFErrors(Of AFValue))

Dim instance As PIServer
Dim values As IList(Of AFValue)
Dim option As AFUpdateOption
Dim bufferOption As AFBufferOption
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFErrors(Of AFValue))

returnValue = instance.UpdateValuesAsync(values, 
	option, bufferOption, cancellationToken)

public:
Task<AFErrors<AFValue^>^>^ UpdateValuesAsync(
	IList<AFValue^>^ values, 
	AFUpdateOption option, 
	AFBufferOption bufferOption, 
	CancellationToken cancellationToken = CancellationToken()
)

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

Parameters

values

Type: System.Collections.GenericIListAFValue
The list of values with an associated PIPoint to be inserted, replaced, or removed to the PI Data Archive.

option

Type: OSIsoft.AF.DataAFUpdateOption
An enumeration value that specifies how to treat duplicate values in the archive. It can also be used to specify that existing values should be removed.

bufferOption

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

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 will take the list of values with an associated PIPoint and update multiple values for multiple points. Multiple values for the same PIPoint can be in the list. The value's PIPoint must be set or its Attribute must be set to an AFAttribute associated with a PIPoint.

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.

Important
Exception reporting is not handled automatically by the AF SDK. Historically, exception reporting has been handled by the application writing data (i.e. Uniint-based interfaces).

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