deleteClientVariable

Deletes a client variable. Returns true if variable was successfully deleted; false if it was not deleted.
NOTE: To test for the existence of a variable, use IsDefined or structKeyExists.)

deleteClientVariable(name) → returns boolean

  1. CFDocs
  2. Functions
  3. All CFML Functions
  4. deleteClientVariable
  5. CF
  6. Lucee
  7. BL 1.0.0+
  8. 0 Issue
  9. Edit
See Also:   getClientVariablesList

Argument Reference

name string
Required

The name of a client variable to delete, surrounded by double-quotation marks.

Compatibility

ColdFusion:

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

Examples
Sample code invoking the deleteClientVariable function

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub