CacheRegionNew()

This function exists solely for the purpose of compatibility with other CFML Engines.

We strongly recommend not to use this function. To create a cache connection either declare it in your Application.cfc or create it via the in the Administrator interface.

Status:

deprecated

Introduced: 5.0.0.0

CacheRegionNew( cacheName=string, properties=any, throwOnError=any, password=string );

Returns: void

Argument Description
cacheName
string, required

the name of the cache connection to create (also known as Region in other CFML engines).

Alias: cache, region

properties
any, optional

a structure specifying the cache properties

Alias: propsStruct, props

throwOnError
any, optional

specifies whether the function should throw an exception if a cache connection with that name already exists.

Default is true.

password
string, optional

the password for the web administrator is required to interact with Cache Connections. You can optionally set it for your Application in Application.cfc using the variable [this.webAdminPassword].

Alias: webAdminPassword

Examples

There are currently no examples for this function 12,040ms WARN No examples for function cacheregionnew

See also