Searches recursively through a substructure of nested arrays, structures, and other elements, for structures whose values match the search key in the value parameter.
An array that contains structures with values that match value.
StructFindKey
(top, value, scope)
Structure functions; Structure functions in Using Arrays and Structures in ColdFusion MX Developer's Guide
Parameter | Description |
---|---|
top |
ColdFusion object (structure or array) from which to start search. This parameter requires an object, not a name of an object. |
value |
String or a variable that contains one for which to search. |
scope |
|
Returns an array that includes one structure for each of the specified values it finds. The fields of each of these structures are:
Value
: value held in the found key
Path
: string that can be used to reach the found key
Owner
: parent object that contains the found key
A structure's keys are unordered.
<cfset aResults = StructFindKey( #request#, "bass" )>