Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PIPoint.RecordedValuesByCount Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
PIPoint.RecordedValuesByCount Method
This method returns a specified number of compressed values beginning at the requested start time in the direction specified.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFValues RecordedValuesByCount(
	AFTime startTime,
	int count,
	bool forward,
	AFBoundaryType boundaryType,
	string filterExpression,
	bool includeFilteredValues
)
Public Function RecordedValuesByCount ( 
	startTime As AFTime,
	count As Integer,
	forward As Boolean,
	boundaryType As AFBoundaryType,
	filterExpression As String,
	includeFilteredValues As Boolean
) As AFValues

Dim instance As PIPoint
Dim startTime As AFTime
Dim count As Integer
Dim forward As Boolean
Dim boundaryType As AFBoundaryType
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim returnValue As AFValues

returnValue = instance.RecordedValuesByCount(startTime, 
	count, forward, boundaryType, filterExpression, 
	includeFilteredValues)
public:
AFValues^ RecordedValuesByCount(
	AFTime startTime, 
	int count, 
	bool forward, 
	AFBoundaryType boundaryType, 
	String^ filterExpression, 
	bool includeFilteredValues
)
member RecordedValuesByCount : 
        startTime : AFTime * 
        count : int * 
        forward : bool * 
        boundaryType : AFBoundaryType * 
        filterExpression : string * 
        includeFilteredValues : bool -> AFValues 

Parameters

startTime
Type: OSIsoft.AF.TimeAFTime
The start time of the request.
count
Type: SystemInt32
The number of compressed values to return. This value 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.
filterExpression
Type: SystemString
A filter expression that follows the performance equation syntax.
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.

Return Value

Type: AFValues
Returns an AFValues collection with the recorded values.

Exceptions

ExceptionCondition
PIExceptionError returned by the PI Data Archive.
ArgumentException The count is less than or equal to zero.

Remarks

Note Note
The PI Data Archive imposes a limit on the maximum number of events that can be returned with a single call. As of PI 3.4.380, the default is set at 1.5M. This behavior can be changed on the server by editing the server's PITimeout table and adding or editing the value associated with the parameter ArcMaxCollect.

Note Notes to Callers
This method, property, or class is not available in the legacy .NET 3.5 version of the SDK.

Version Information

AFSDK


See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in