User Guide

226 Chapter 12 Using the Application Framework

Getting a list of Client variables

To obtain a list of the custom client parameters associated with a particular client,

use the

GetClientVariablesList function.

<cfoutput>#GetClientVariablesList()#</cfoutput>

The GetClientVariablesList function returns a comma-separated list of the names

of the Client variables for the current application. The standard system-provided

Client variables (CFID, CFToken, URLToken, HitCount, TimeCreated, and LastVisit)

are not returned in the list.

Deleting Client variables

Unlike normal variables, Client variables and their values are not stored in volatile

memory and persist over time. To delete a Client variable, use the

DeleteClientVariable function; for example:

The DeleteClientVariable function deletes only Client variables for the application

specified by

cfapplication, if any. For more information on this function, see the

CFML Reference.

Also, using the Client Variables page of the ColdFusion Administrator Server tab, you

can edit the Client variable storage to remove Client variables stored in either the

Registry or a database after a set number of days. (The default value is 90 days when

Client variables are stored in the registry, 10 days when stored in a data source.)

For more information about setting timeout values, see Advanced ColdFusion

Administration.

Note

You cannot delete the system-provided Client variables (CFID, CFToken, URLToken,

HitCount, TimeCreated, and LastVisit).

Using Client variables with cflocation

If you use the cflocation tag to redirect to a path that ends in .dbm or .cfm, the

Client.URLToken is automatically appended to the URL. You can suppress this

behavior by adding the attribute addtoken="No" to the cflocation tag.

Client variable caching

All Client variable reads and writes are cached to help decrease the overhead of client

state management operations. For information on variables and server clustering,

see Advanced ColdFusion Administration.