GetClientVariablesList

Description

Returns a list of non-read-only client variables available to a template.

Category

Other functions

Syntax

GetClientVariablesList() 

See also

DeleteClientVariable

Usage

You can use the list of variables returned by GetClientVariablesList with ColdFusion list functions, because the returned list is comma-delimited, so it is compatible with ColdFusion list functions.

Example

<!--- This view-only example shows GetClientVariablesList --->
<html>
<head>
<title>GetClientVariablesList Example</title>
</head>

<body>
<!--- this example is view only --->
 
<H3>GetClientVariablesList Example</H3>

<P>This view-only example deletes a client variable called "User_ID",
if it exists in the list of client variables returned by
GetClientVariablesList().
<P>This example requires the existance of an Application.cfm file 
and that client management be in effect.
<!---
<cfset client.somevar = "">
<cfset client.user_id = "">
<P>Client variable list:<cfoutput>#GetClientVariablesList()#</cfoutput>

<cfif ListFindNoCase(GetClientVariablesList(), "User_ID") is not 0>
<!--- delete that variable 
  <cfset temp = DeleteClientVariable("User_ID")>
  <P>Was variable "User_ID" Deleted? <cfoutput>#temp#</cfoutput>
</cfif>

<P>Amended Client variable list:<cfoutput>#GetClientVariablesList()#
 </cfoutput>
--->
</body>
</html>