Description

Determines whether a variable is a structure.

Returns

True, if variable is a ColdFusion structure or is a Java object that implements the java.lang.Map interface. The return value is False if the object in variable is a user-defined function (UDF).

Category

Decision functions, Structure functions

Function syntax

IsStruct(variable)

See also

Structure functions; "Modifying a ColdFusion XML object" in the ColdFusion Developer's Guide

History

ColdFusion MX: Changed behavior: this function can be used on XML objects.

Parameters

Example

<!--- This view-only example shows the use of IsStruct. --->
<p>This file is similar to addemployee.cfm, which is called by StructNew,
    StructClear, and StructDelete. 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 IsStruct(attributes.EMPINFO)>
    <cfoutput>Error. Invalid data.</cfoutput>
    <cfexit method = "ExitTag">
 <cfelse>
    <cfquery name = "AddEmployee" datasource = "cfdocexamples">
    INSERT INTO Employees
    (FirstName, LastName, Email, Phone, Department)
    VALUES 
    <cfoutput>
    (
    '#StructFind(attributes.EMPINFO, "firstname")#' ,
    '#StructFind(attributes.EMPINFO, "lastname")#' ,
    '#StructFind(attributes.EMPINFO, "email")#' ,
    '#StructFind(attributes.EMPINFO, "phone")#' ,
    '#StructFind(attributes.EMPINFO, "department")#'
    )
    </cfoutput> 
    </cfquery>
</cfif>
<cfoutput><hr>Employee Add Complete</cfoutput>
</cfcase>
</cfswitch> --->