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
|
|
History
|
ColdFusion MX: Changed behavior: this function can be used on XML objects.
|
|
Parameters
|
|
Parameter |
Description |
structure |
Structure to clear |
|
|
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);
StructInsert(employee, "lastname", Form.lastname);
StructInsert(employee, "email", Form.email);
StructInsert(employee, "phone", Form.phone);
StructInsert(employee, "department", Form.department);
</cfscript>
</cfoutput>
<!--- Call the custom tag that adds employees --->
<cf_addemployee empinfo = "#employee#">
<cfscript>StructClear(employee);</cfscript>
</cfif>
|