StructFindKey

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.

Syntax


StructFindKey(top, value, scope)

Parameters

Parameter

Description

top
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.

value
The string to search for.

scope
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.")

Parameter	Description
top	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.
value	The string to search for.
scope	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.")

Usage

StructFindKey returns an array that consists of 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

Example

  <CFSET aResults = StructFindKey( #request#, "bass" )>