CFLib.org – Common Function Library Project

Description:
Returns a key value from the given struct, or a default value.

Return Values:
Returns a value.

Example:

<cfset myData = structNew()>
<cfset mydata.keyThatExists = 1>

<cfset result1 = structGetKey(myData, "keyThatExists", "not found") /> <!--- this returns the value of myData.keyThatExists --->
<cfset result2 = structGetKey(myData, "keyThatNOTExists", "not found") /> <!--- this returns "not found" --->
<cfoutput>#result1#<br />#result2#</cfoutput>

Parameters:

Full UDF Source:

/**
 * Returns a key value from the given struct, or a default value.
 * 
 * @param theStruct      The structure. (Required)
 * @param theKey      Key name. (Required)
 * @param defaultValue      Default value to use if key does not exist. (Required)
 * @return Returns a value. 
 * @author Adam Tuttle (j.adam.tuttle@gmail.com) 
 * @version 0, September 9, 2008 
 */
function structGetKey(theStruct, theKey, defaultVal){
    if (structKeyExists(arguments.theStruct, arguments.theKey)){
        return arguments.theStruct[arguments.theKey];
    }else{
        return arguments.defaultVal;
    }
}