PIPoint.UpdateValuesAsync Method (IList(AFValue), AFUpdateOption, AFBufferOption, CancellationToken)
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method writes or replaces one or more values on the target system using the configured data reference.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[HandleProcessCorruptedStateExceptionsAttribute] public Task<AFErrors<AFValue>> UpdateValuesAsync( IList<AFValue> values, AFUpdateOption updateOption, AFBufferOption bufferOption, CancellationToken cancellationToken = default )
<HandleProcessCorruptedStateExceptionsAttribute> Public Function UpdateValuesAsync ( values As IList(Of AFValue), updateOption As AFUpdateOption, bufferOption As AFBufferOption, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of AFErrors(Of AFValue)) Dim instance As PIPoint Dim values As IList(Of AFValue) Dim updateOption As AFUpdateOption Dim bufferOption As AFBufferOption Dim cancellationToken As CancellationToken Dim returnValue As Task(Of AFErrors(Of AFValue)) returnValue = instance.UpdateValuesAsync(values, updateOption, bufferOption, cancellationToken)
public: [HandleProcessCorruptedStateExceptionsAttribute] Task<AFErrors<AFValue^>^>^ UpdateValuesAsync( IList<AFValue^>^ values, AFUpdateOption updateOption, AFBufferOption bufferOption, CancellationToken cancellationToken = CancellationToken() )
[<HandleProcessCorruptedStateExceptionsAttribute>] member UpdateValuesAsync : values : IList<AFValue> * updateOption : AFUpdateOption * bufferOption : AFBufferOption * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken new CancellationToken() *) -> Task<AFErrors<AFValue>>
Parameters
- values
- Type: System.Collections.GenericIListAFValue
The values to be written or replaced on the target system. - updateOption
- Type: OSIsoft.AF.DataAFUpdateOption
An enumeration value that specifies how to treat duplicate values. It can also be used to specify that an existing value should be removed. - 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
Type: TaskAFErrorsAFValueReturns a task whose result is if there are no errors. Otherwise the result is an AFErrorsTKey instance containing error information.
Exceptions
| Exception | Condition |
|---|---|
| AggregateException | Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure. |
Remarks
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.
| 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. |