User Guide Cancel

ArrayIsDefined

 

Description

Determines whether an array element is defined.

Returns

True, if the array element is defined (exists); false, otherwise.

Category

Array functions

Function syntax

ArrayIsDefined(array, index)

See also

ArrayIsEmpty

History

ColdFusion 8: Added this function.

Parameters

Parameter

Description

array

Name of a one-dimensional array, or the array name and indexes into higher-order dimensions of a multidimensional array.

index

Index of the element in a one-dimensional array, or the index of the element in the final dimension of a multidimensional array.

Usage

The index value of an element must be less than the length of the array.To test the existence of an element in a multidimensional array, specify all but the last dimension of the array in the first parameter.

Heading

<cfscript>
myCities=["London","New York","Paris","Tokyo","Barcelona"];
WriteOutput(ArrayIsDefined(myCities,4) & " | "); //returns True since index 4 exists in the array
WriteOutput(ArrayIsDefined(myCities,6)); //returns False since index 6 does not exist in the array
</cfscript>
<cfscript> myCities=["London","New York","Paris","Tokyo","Barcelona"]; WriteOutput(ArrayIsDefined(myCities,4) & " | "); //returns True since index 4 exists in the array WriteOutput(ArrayIsDefined(myCities,6)); //returns False since index 6 does not exist in the array </cfscript>
<cfscript>
       myCities=["London","New York","Paris","Tokyo","Barcelona"];
       WriteOutput(ArrayIsDefined(myCities,4) & " | "); //returns True since index 4 exists in the array
       WriteOutput(ArrayIsDefined(myCities,6)); //returns False since index 6 does not exist in the array
</cfscript>

Output

YES | NO

Get help faster and easier

New user?