User Guide
Chapter 2: ColdFusion Functions 539
StructUpdate
Updates the specified key with the specified value. Returns Yes if the function is
successful and throws an exception if an error occurs.
See also StructClear, StructDelete, StructFind, StructInsert, StructIsEmpty,
StructKeyArray, StructCount, and StructKeyArray.
Syntax StructUpdate(
structure
,
key
,
value
)
structure
Structure to be updated.
key
Key whose value is updated.
value
New value.
Usage This function throws an exception if structure does not exist.
Example <!--- This example illustrates usage of StructUpdate. --->
<P>This file is similar to addemployee.cfm, which is called
by StructNew, StructClear, and StructDelete. To test this file,
copy the <CFELSEIF> statement to the appropriate place
in addemployee.cfm. It is an example of a custom tag used
to add employees. Employee information is passed through the
employee structure (the EMPINFO attribute). In UNIX, you must
also add the Emp_ID.
<CFSWITCH EXPRESSION="#ThisTag.ExecutionMode#">
<CFCASE VALUE="start">
<CFIF StructIsEmpty(attributes.EMPINFO)>
<CFOUTPUT>Error. No employee data was passed.</CFOUTPUT>
<CFEXIT METHOD="ExitTag">
<CFELSEIf StructFind(attributes.EMPINFO, "department") EQ "">
<CFSCRIPT>
StructUpdate(attributes.EMPINFO, "department", "Unassigned");
</CFSCRIPT>
<CFEXIT METHOD="ExitTag">
<CFELSE>
...