Click or drag to resize
OSIsoft, LLC

PIPointRecordedValuesByCount 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:
public AFValues RecordedValuesByCount(
	AFTime startTime,
	int count,
	bool forward,
	AFBoundaryType boundaryType,
	string filterExpression,
	bool includeFilteredValues


Type: OSIsoft.AF.TimeAFTime
The start time of the request.
Type: SystemInt32
The number of compressed values to return. This value must be greater than zero.
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.
Type: OSIsoft.AF.DataAFBoundaryType
A value from the AFBoundaryType enumeration that determines how the time and value at the start time is determined.
Type: SystemString
A filter expression that follows the performance equation syntax.
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.
PIExceptionError returned by the PI Data Archive.
ArgumentException The count is less than or equal to zero.
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 only available in the .NET 4 version of the SDK.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence