arrayDeleteAt

Description

Deletes an element from a specified position in an array.

History

ColdFusion MX: Changed behavior: This function can be used on XML objects. Changed thrown exceptions: This function can throw the InvalidArrayIndexException error.

Syntax

ArrayDeleteAt(array, position)

Attributes

Attribute	Description	Required	Default
array	Name of an array
position	Array position

Returns

True, on successful completion.

Example

<h3>ArrayDeleteAt Example</h3> 
<!--- Create an array. ---> 
<cfset DaysArray = ArrayNew(2)> 
<!--- Populate an element or two. ---> 
<cfset DaysArray[1][1] = "Monday"> 
<cfset DaysArray[2][1] = "Tuesday"> 
<cfset DaysArray[3][1] = "Wednesday"> 
<cfset DaysArray[1][2] = "April 12"> 
<cfset DaysArray[2][2] = "April 13"> 
<cfset DaysArray[3][2] = "April 14"> 
This is what the array looks like before delete:<br> 
<cfoutput> 
#DaysArray[1][1]#&nbsp;&nbsp;#DaysArray[1][2]#<br> 
#DaysArray[2][1]#&nbsp;&nbsp;#DaysArray[2][2]#<br> 
#DaysArray[3][1]#&nbsp;&nbsp;#DaysArray[3][2]#<br> 
</cfoutput> 
 
<cfoutput> 
We delete this element of the array:<br> 
#ArrayDeleteAt(DaysArray,2)#<br> 
</cfoutput> 
<!--- The formerly third element, "Wednesday" is now the second element. ---> 
This is what the array looks like after delete:<br> 
<cfoutput> 
#DaysArray[1][1]#&nbsp;&nbsp;#DaysArray[1][2]#<br> 
#DaysArray[2][1]#&nbsp;&nbsp;#DaysArray[2][2]#<br> 
</cfoutput>

cfmldocs