DeleteClientVariable

Description

Deletes a client variable. (To test for the existence of a variable, use IsDefined.)

Returns

True, if the variable is successfully deleted; false, otherwise.

Category

Other functions

Function syntax

DeleteClientVariable("name")

See also

GetClientVariablesList

History

ColdFusion MX: Changed behavior: if the variable is not present, this function now returns False. (In earlier releases, it threw an error.)

Parameters

Example

<!--- This view-only example shows DeleteClientVariable ---> 
<h3>DeleteClientVariable 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 existence of an Application.cfm file and client 
    management to 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> 
 
        <cfset temp = DeleteClientVariable("User_ID")> 
        <p>Was variable "User_ID" Deleted? <cfoutput>#temp#</cfoutput> 
</cfif> 
<p>Amended Client variable list:<cfoutput>#GetClientVariablesList()# 
</cfoutput> 
--->