User Guide
850 Chapter 3: ColdFusion Functions
StructClear
Description
Removes all data from a structure.
Returns
True, on successful execution; False, otherwise.
Category
Structure functions
Function syntax
StructClear(structure)
See also
Structure functions; “Modifying a ColdFusion XML object” in Chapter 35, “Using XML and
WDDX,” in ColdFusion MX Developer’s Guide
History
ColdFusion MX: Changed behavior: this function can be used on XML objects.
Parameters
Usage
Do not call this function on a session variable. For more information, see TechNote 14143,
“ColdFusion 4.5 and the StructClear(Session) function,” at www.coldfusion.com/Support/
KnowledgeBase/SearchForm.cfm. (The article applies to ColdFusion 4.5, 5.x, and
ColdFusion MX.)
Example
<!--- Shows StructClear function. Calls cf_addemployee custom tag which
uses the addemployee.cfm file. --->
<body>
<h1>Add New Employees</h1>
<!--- Establish params for first time through --->
<cfparam name = "Form.firstname" default = "">
<cfparam name = "Form.lastname" default = "">
<cfparam name = "Form.email" default = "">
<cfparam name = "Form.phone" default = "">
<cfparam name = "Form.department" default = "">
<cfif form.firstname eq "">
<p>Please fill out the form.
<cfelse>
<cfoutput>
<cfscript>
employee = StructNew();
StructInsert(employee, "firstname", Form.firstname);
Parameter Description
structure Structure to clear