AFDataReference.UpdateValues Method (AFValues, AFUpdateOption)

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

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

Dim instance As AFDataReference
Dim values As AFValues
Dim updateOption As AFUpdateOption
Dim returnValue As AFErrors(Of AFValue)

returnValue = instance.UpdateValues(values, 
	updateOption)

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

abstract UpdateValues : 
        values : AFValues * 
        updateOption : AFUpdateOption -> AFErrors<AFValue> 
override UpdateValues : 
        values : AFValues * 
        updateOption : AFUpdateOption -> AFErrors<AFValue> 

Parameters

values

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

updateOption

Type: OSIsoft.AF.DataAFUpdateOption
An enumeration value that specifies how duplicate values should be handled.

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