AFDataReference.ReplaceValues Method (AFTimeRange, AFValues, AFBufferOption)

public virtual AFErrors<AFValue> ReplaceValues(
	AFTimeRange timeRange,
	AFValues values,
	AFBufferOption bufferOption
)

Public Overridable Function ReplaceValues ( 
	timeRange As AFTimeRange,
	values As AFValues,
	bufferOption As AFBufferOption
) As AFErrors(Of AFValue)

Dim instance As AFDataReference
Dim timeRange As AFTimeRange
Dim values As AFValues
Dim bufferOption As AFBufferOption
Dim returnValue As AFErrors(Of AFValue)

returnValue = instance.ReplaceValues(timeRange, 
	values, bufferOption)

public:
virtual AFErrors<AFValue^>^ ReplaceValues(
	AFTimeRange timeRange, 
	AFValues^ values, 
	AFBufferOption bufferOption
)

abstract ReplaceValues : 
        timeRange : AFTimeRange * 
        values : AFValues * 
        bufferOption : AFBufferOption -> AFErrors<AFValue> 
override ReplaceValues : 
        timeRange : AFTimeRange * 
        values : AFValues * 
        bufferOption : AFBufferOption -> AFErrors<AFValue> 

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for replacement of the existing values.

values

Type: OSIsoft.AF.AssetAFValues
The replacement values to be written on the target system. If an empty AFValues then existing data within the specified AFTimeRange will be deleted. The timestamp of AFValue in values must be within the specified AFTimeRange.

bufferOption

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

Return Value

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

If AFBufferOption is set to Buffer, this method requires that the attribute has a configured data reference which supports buffering. This is indicated by having the Buffering flag set in the SupportedDataMethods property. The PI Point Data Reference supports buffering.

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.

AFSDK

Reference