AFData.UpdateValues Method (AFValues, AFUpdateOption)

public AFErrors<AFValue> UpdateValues(
	AFValues values,
	AFUpdateOption option
)

Public Function UpdateValues ( 
	values As AFValues,
	option As AFUpdateOption
) As AFErrors(Of AFValue)

Dim instance As AFData
Dim values As AFValues
Dim option As AFUpdateOption
Dim returnValue As AFErrors(Of AFValue)

returnValue = instance.UpdateValues(values, 
	option)

public:
AFErrors<AFValue^>^ UpdateValues(
	AFValues^ values, 
	AFUpdateOption option
)

member UpdateValues : 
        values : AFValues * 
        option : AFUpdateOption -> AFErrors<AFValue> 

Parameters

values

Type: OSIsoft.AF.AssetAFValues
The values to be written or replaced on the target system.

option

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.

Return Value

This method requires that the attributes being written, if configured with a data reference, must support the UpdateValues method. This is indicated by having the UpdateValues flag set in the SupportedDataMethods property. The PI Point Data Reference supports UpdateValues for simply configured PI Points.

For the case of attributes which are configuration items, this method (unlike AFAttribute.SetValue) does not require the corresponding AFElement to be checked out or checked in.

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 method, property, or class is not available in the legacy .NET 3.5 version of the SDK.

Security Note
You must have WriteData security rights to write a data value.

Important
This method is not supported for attributes that do not have a data reference. Consider using AFListData.UpdateValues.

AFSDK

Reference