Deletes the client variable specified by name. Returns a Boolean TRUE when variable is successfully deleted, even if variable did not previously exist. To test for the existence of a variable, use IsDefined.
See also GetClientVariablesList.
DeleteClientVariable("name")
Name of a client variable to be deleted, surrounded by double quotes.
If the client variable specified by name does not exist, an error is returned.
<!--- This view-only example shows DeleteClientVariable ---> <HTML> <HEAD> <TITLE>DeleteClientVariable Example</TITLE> </HEAD> <BODY> <!--- this example is view only ---> <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 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>