MACROMEDIA COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX, Reference

Page: 864 / 1108

864 Chapter 3: ColdFusion Functions
StructGet
Description
Gets a structure(s) from a specified path.
Returns
An alias to the variable in the pathDesired parameter. If necessary,
StructGet
creates structures or
arrays to make pathDesired a valid variable "path."
Category
Structure functions
Function syntax
StructGet ( pathDesired )
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.
•
Changed behavior: if there is no structure or array present in pathDesired , this function creates
structures or arrays to make pathDesired a valid variable "path."
Parameters
Usage
You can inadvertently create invalid structures using this function. For example, if array notation
is used to expand an existing array, the specified new element is created, regardless of the type
currently held in the array.
Example
<!--- GetStruct() test --->
<cfset test = StructGet( "dog.myscope.test" )>
<cfset test.foo = 1>
<cfif NOT IsDefined("dog")>
Dog is not defined<br>
</cfif>
<cfif NOT IsDefined("dog.myscope")>
Dog.Myscope is not defined<br>
</cfif>
<cfif NOT Isdefined("dog.myscope.test")>
Dog.Myscope.Test is not defined<br>
</cfif>
Parameter Description
pathDesired Pathname of variable that contains structure or array from which ColdFusion
retrieves structure.