AFData.RecordedValuesByCountAsync Method

public Task<AFValues> RecordedValuesByCountAsync(
	AFTime startTime,
	int count,
	bool forward,
	AFBoundaryType boundaryType,
	UOM desiredUOM,
	string filterExpression,
	bool includeFilteredValues,
	CancellationToken cancellationToken = default
)

Public Function RecordedValuesByCountAsync ( 
	startTime As AFTime,
	count As Integer,
	forward As Boolean,
	boundaryType As AFBoundaryType,
	desiredUOM As UOM,
	filterExpression As String,
	includeFilteredValues As Boolean,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFValues)

Dim instance As AFData
Dim startTime As AFTime
Dim count As Integer
Dim forward As Boolean
Dim boundaryType As AFBoundaryType
Dim desiredUOM As UOM
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.RecordedValuesByCountAsync(startTime, 
	count, forward, boundaryType, desiredUOM, 
	filterExpression, includeFilteredValues, 
	cancellationToken)

public:
Task<AFValues^>^ RecordedValuesByCountAsync(
	AFTime startTime, 
	int count, 
	bool forward, 
	AFBoundaryType boundaryType, 
	UOM^ desiredUOM, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	CancellationToken cancellationToken = CancellationToken()
)

member RecordedValuesByCountAsync : 
        startTime : AFTime * 
        count : int * 
        forward : bool * 
        boundaryType : AFBoundaryType * 
        desiredUOM : UOM * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<AFValues> 

Parameters

startTime

Type: OSIsoft.AF.TimeAFTime
The start time of the request.

count

Type: SystemInt32
The number of compressed values to return. This number must be greater than zero.

forward

Type: SystemBoolean
A value of indicates to begin at the start time and move forward in time. A value of indicates to move backward in time. When moving backward, values will be returned in time descending order.

boundaryType

Type: OSIsoft.AF.DataAFBoundaryType
A value from the AFBoundaryType enumeration that determines how the time and value at the start time is 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.

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