CFML Language Reference
Chapter 2 :  ColdFusion Functions

StructKeyExists

Returns TRUE if the specified key is in the specified structure and FALSE if it is not.

See also StructClear, StructDelete, StructFind, StructInsert, StructIsEmpty, StructCount, StructKeyArray, and StructUpdate.

Syntax

StructKeyExists(structure, key)

structure

Structure to be tested.

key

Key to be tested.

Usage

This function throws an exception if structure does not exist.

Example

<!--- This example illustrates usage of StructKeyExists. --->
<P>This file is similar to addemployee.cfm, which is called
by StructNew, StructClear, and StructDelete. To test this file,
copy the &LT;CFELSEif&GT; statement to the appropriate place
in addemployee.cfm. It is an example of a custom tag used 
to add employees. Employee information is passed through the 
employee structure (the EMPINFO attribute). In UNIX, you must 
also add the Emp_ID.

<CFSWITCH EXPRESSION="#ThisTag.ExecutionMode#">
   <CFCASE VALUE="start">
      <CFIF StructIsEmpty(attributes.EMPINFO)>
        <CFOUTPUT>Error. No employee data was passed.</CFOUTPUT>
          <CFEXIT METHOD="ExitTag">
      <CFELSEIf NOT StructKeyExists(attributes.EMPINFO, "department")>
        <CFSCRIPT>StructUpdate(attributes.EMPINFO, "department",
            "Unassigned");
        </CFSCRIPT>
        <CFEXIT METHOD="ExitTag">
              <CFELSE>
          ...

Copyright © 1999, Allaire Corporation. All rights reserved.