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

AF SDK Reference

PIPagingConfiguration Constructor (PIPageType, Int32, Nullable(TimeSpan), Nullable(TimeSpan), Nullable(Int32))

PIPagingConfiguration Constructor (PIPageType, Int32, Nullable(TimeSpan), Nullable(TimeSpan), Nullable(Int32))

  • Last UpdatedNov 18, 2025
  • 3 minute read
PIPagingConfiguration Constructor (PIPageType, Int32, Nullable(TimeSpan), Nullable(TimeSpan), Nullable(Int32))
Initializes a new instance of PIPagingConfiguration

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

Syntax

public PIPagingConfiguration(
	PIPageType pageType,
	int pageSize,
	TimeSpan? operationTimeoutOverride = null,
	TimeSpan? keepAliveTimeout = null,
	int? bulkPayloadPercentThreshold = null
)
Public Sub New ( 
	pageType As PIPageType,
	pageSize As Integer,
	Optional operationTimeoutOverride As TimeSpan? = Nothing,
	Optional keepAliveTimeout As TimeSpan? = Nothing,
	Optional bulkPayloadPercentThreshold As Integer? = Nothing
)

Dim pageType As PIPageType
Dim pageSize As Integer
Dim operationTimeoutOverride As TimeSpan?
Dim keepAliveTimeout As TimeSpan?
Dim bulkPayloadPercentThreshold As Integer?

Dim instance As New PIPagingConfiguration(pageType, 
	pageSize, operationTimeoutOverride, 
	keepAliveTimeout, bulkPayloadPercentThreshold)
public:
PIPagingConfiguration(
	PIPageType pageType, 
	int pageSize, 
	Nullable<TimeSpan> operationTimeoutOverride = nullptr, 
	Nullable<TimeSpan> keepAliveTimeout = nullptr, 
	Nullable<int> bulkPayloadPercentThreshold = nullptr
)
new : 
        pageType : PIPageType * 
        pageSize : int * 
        ?operationTimeoutOverride : Nullable<TimeSpan> * 
        ?keepAliveTimeout : Nullable<TimeSpan> * 
        ?bulkPayloadPercentThreshold : Nullable<int> 
(* Defaults:
        let _operationTimeoutOverride = defaultArg operationTimeoutOverride null
        let _keepAliveTimeout = defaultArg keepAliveTimeout null
        let _bulkPayloadPercentThreshold = defaultArg bulkPayloadPercentThreshold null
*)
-> PIPagingConfiguration

Parameters

pageType
Type: OSIsoft.AF.PIPIPageType
The method used to page intermediary results.
pageSize
Type: SystemInt32
The size of the pages that will be returned depending on the PageType.
operationTimeoutOverride (Optional)
Type: SystemNullableTimeSpan
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.
keepAliveTimeout (Optional)
Type: SystemNullableTimeSpan
This value is the maximum amount of time allowed to elapse between calls to get the next page of results.
bulkPayloadPercentThreshold (Optional)
Type: SystemNullableInt32
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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

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