CFLib.org – Common Function Library Project

Description:
This function deletes all client variables for a user. An optional list can be passed to ignore certain client variables.

Return Values:
Returns true.

Example:

No example for this code since we do not use client variables on cflib.org.

Parameters:

Full UDF Source:

<cfscript>
/**
 * This function deletes all client variables for a user.
 * Version 2 mods by Tony Petruzzi
 * 
 * @param safeList 	 A list of client vars to NOT delete. 
 * @return Returns true. 
 * @author Bernd VanSkiver (&#98;&#101;&#114;&#110;&#100;&#64;&#115;&#104;&#97;&#100;&#111;&#119;&#100;&#101;&#115;&#105;&#103;&#110;&#46;&#110;&#101;&#116;) 
 * @version 2, January 29, 2002 
 */
function DeleteClientVariables() {
	var ClientVarList = GetClientVariablesList();
	var safeList = "";
	var i = 1;

	if(ArrayLen(Arguments) gte 1) safeList = Arguments[1];

	for(i=1; i lte listLen(ClientVarList); i=i+1) {
		if(NOT ListFindNoCase(safeList, ListGetAt(ClientVarList, i )))  DeleteClientVariable(ListGetAt(ClientVarList, i));
	}
	return true;
}
</cfscript>