AFData.RecordedValuesAsync Method

public Task<AFValues> RecordedValuesAsync(
	AFTimeRange timeRange,
	AFBoundaryType boundaryType,
	UOM desiredUOM,
	string filterExpression,
	bool includeFilteredValues,
	int maxCount = 0,
	CancellationToken cancellationToken = default
)

Public Function RecordedValuesAsync ( 
	timeRange As AFTimeRange,
	boundaryType As AFBoundaryType,
	desiredUOM As UOM,
	filterExpression As String,
	includeFilteredValues As Boolean,
	Optional maxCount As Integer = 0,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFValues)

Dim instance As AFData
Dim timeRange As AFTimeRange
Dim boundaryType As AFBoundaryType
Dim desiredUOM As UOM
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim maxCount As Integer
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.RecordedValuesAsync(timeRange, 
	boundaryType, desiredUOM, filterExpression, 
	includeFilteredValues, maxCount, 
	cancellationToken)

public:
Task<AFValues^>^ RecordedValuesAsync(
	AFTimeRange timeRange, 
	AFBoundaryType boundaryType, 
	UOM^ desiredUOM, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	int maxCount = 0, 
	CancellationToken cancellationToken = CancellationToken()
)

member RecordedValuesAsync : 
        timeRange : AFTimeRange * 
        boundaryType : AFBoundaryType * 
        desiredUOM : UOM * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        ?maxCount : int * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _maxCount = defaultArg maxCount 0
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<AFValues> 

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for the recorded values request. If the StartTime is earlier than the EndTime, the resulting values will be in time-ascending order, otherwise they will be in time-descending order.

boundaryType

Type: OSIsoft.AF.DataAFBoundaryType
A value from the AFBoundaryType enumeration that determines how the times and values of the returned end points are determined.

desiredUOM

Type: OSIsoft.AF.UnitsOfMeasureUOM
The desired unit of measure for the returned values. If , then the values are returned in the unit of measure specified by the associated attribute's DefaultUOM property.

filterExpression

Type: SystemString
A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. A or empty string indicates no filtering. If the attribute does not support the Filters option, the filter will be ignored.

includeFilteredValues

Type: SystemBoolean
Specify to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a "Filtered" enumeration value with bad status. Repeated consecutive failures are omitted.

maxCount (Optional)

Type: SystemInt32
The maximum number of values to be returned. If zero, then all of the events within the requested time range will be returned. When the maximum number of values is exceeded, if the timeRange provided has the start time before the end time, the earliest events are returned; if the start time is later than the end time, the latest events are returned

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

AFSDK

Reference