ColdFusion 9.0 Resources

CacheGetProperties

Description

Gets the cache properties for the object cache, the page cache, or both. The information is application-specific.

Returns

An Array of structures containing the cache properties. Each structure has the properties for the cache type: object or page. If you specify either type in the parameter, the array has a single structure entry. Each structure has the following fields:

Structure element	Description
`diskpersistent`	A Boolean value specifying whether to persist caches stored on disk through JVM restarts.
`eternal`	A Boolean value specifying whether no timeout or idletime applies. A true value indicates that the object or page is cached without any timespan being specified.
`maxelementsinmemory`	The maximum number of objects that can be cached in memory. If the number is exceeded and `overflowtodisk` is false, the new objects entered replace old elements using algorithm specified in the memoryevictionpolicy entry.
`maxelementsondisk`	The maximum number of objects that can be stored on disk if `overfllowtodisk` is true.
`memoryevictionpolicy`	The algorithm to used to evict old entries when maximum limit is reached, such as LRU (least recently used) or LFU (least frequently used).
`objecttype`	The cache type: `object` or `template`.
`overflowtodisk`	A Boolean value specifying whether when the maximum number of elements allowed in memory is reached, objects can be moved to disk, as determined by the memoryevictionpolicy value.
`timetoidoleconds`	The idle time in seconds. Used if a `cfcache` tag does not specify an `idleTime` attribute.
`timetolivesecond`	The timeout time in seconds. Used if a `cfcache` tag does not specify a `timespan` attribute.

Function syntax

CacheGetProperties([type])

History

ColdFusion 9: Added the function.

Parameters

Parameter	Description
`type`	(Optional) The cache type: `template` - Get properties for the page cache, which contains cached pages and page segments. `object` - Get properties for the object cache. no parameter - Get properties for both cache types.