AF SDK Reference

IAFSearch(T).CacheInterval Property

Save PDF

TABLE OF CONTENTS

IAFSearch(T).CacheInterval Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The search's cached automatic refresh interval.

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

Syntax

TimeSpan CacheInterval { get; set; }

Property CacheInterval As TimeSpan
	Get
	Set

Dim instance As IAFSearch
Dim value As TimeSpan

value = instance.CacheInterval

instance.CacheInterval = value

property TimeSpan CacheInterval {
	TimeSpan get ();
	void set (TimeSpan value);
}

abstract CacheInterval : TimeSpan with get, set

Property Value

Type: TimeSpan
The amount of time until the search's cached items are automatically refreshed. Specify a value of TimeSpan.Zero to disable automatic refresh of the search. The default value is TimeSpan.Zero which disables automatic refresh.

Remarks

This property controls how often the search's cached items are automatically refreshed. When the specified cache interval has expired, the cached search is automatically updated before returning the next page of results. Negative values are handled the same as a zero timespan. The Refresh method can be used to manually force the cached search to be updated.

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

AF SDK Reference