PIPagingConfiguration Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PIPagingConfiguration is used to describe how PIPointList and AFListData data access calls
should page results for better performance.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.PIPIPagingConfiguration
OSIsoft.AF.PIPIPagingConfiguration
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public class PIPagingConfiguration
Public Class PIPagingConfiguration Dim instance As PIPagingConfiguration
public ref class PIPagingConfiguration
type PIPagingConfiguration = class end
The PIPagingConfiguration type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PIPagingConfiguration(PIPageType, Int32) |
Initializes a new instance of PIPagingConfiguration |
| PIPagingConfiguration(PIPageType, Int32, NullableTimeSpan, NullableTimeSpan, NullableInt32) |
Initializes a new instance of PIPagingConfiguration |
| PIPagingConfiguration(PIPageType, Int32, Int32, NullableTimeSpan, NullableTimeSpan, NullableInt32) |
Initializes a new instance of PIPagingConfiguration |
Properties
| Name | Description | |
|---|---|---|
 | BulkPayloadPercentThreshold |
This value represents a percentage of the entire RPC that must be completed to cause a page to be
proactively returned to prevent the operation timeout from expiring.
|
| Error |
Contains the exception that caused the OperationCanceledException to be thrown canceling the operation.
|
| KeepAliveTimeout |
This value is the maximum amount of time allowed to elapse between calls to get the next
page of results.
|
| MaximumRetries |
The maximum number of times to retry when encountering an error from PIServer
for exceeding the maximum number of concurrent bulk queries. It must be a non-negative number.
The default value is 5.
|
| OperationTimeoutOverride |
This value overrides the operation timeout set on the PIServer for the duration
of the data access call. The operation timeout is the maximum amount of time that can elapse on the
PIServer while fetching each page.
|
| PageSize |
The size of the pages that will be returned depending on the PageType.
|
| PageType |
The PageType is used to determine how partial results
from list data access calls should be grouped while being returned to the client.
Choosing the appropriate page type will improve performance.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |