Structfindvalue - MACROMEDIA COLDFUSION 5 - CFML Reference

Alphabetical List of ColdFusion Functions

StructFindValue

Description Searches recursively through a sub-structure of nested arrays, structures, and other
elements and returns an array containing any structures with values that match the
search key specified in the value parameter.
StructFindValue( top, value [, scope])
Syntax
See also
StructDelete
StructKeyArray, StructKeyExists, StructKeyList, StructCount, StructNew,
StructUpdate, StructSort, StructFindKey,
Parameters
Parameter
top
value
scope
Usage Returns an array of structures, one structure for each find of the specified value. If no
matches are found, an array is still returned but its size is 0. The fields of each of these
structures are:
Example <CFSET aResults = StructFindValue( #request#, "235" )>
,
StructFind, StructGet, StructInsert, StructIsEmpty,
Description
The ColdFusion object (either a structure or an array) from
which to start the recursive search. It is the object not the name
of the object.
The string to search for. The type must be a simple object,
arrays and structures are not supported.
Optional. Specifies whether one or all of the matching keys
should be returned. Valid entries for the Scope parameter are
"ONE" and "ALL" (default is "ONE.")
: Name of the key in which the specified value was found
Key
: String which could be used to reach the found key
Path
: Parent object which contains the found key
Owner
StructAppend
611