Deletes an element from a specified position in an array. When an element is deleted, ColdFusion recalculates index positions. For example, in an array that contains the months of the year, deleting the element at position 5 removes the entry for May. After this, to delete the entry for June, you would delete the element at position 5 (not 6).
ColdFusion (2018 release): Returns the updated array.
- Changed behavior: This function can be used on XML objects.
- Changed thrown exceptions: This function can throw the InvalidArrayIndexException error.
If this function attempts to delete an element at position 0, or specifies a value for position that is greater than the size of array, this function throws an InvalidArrayIndexException error.
<cfscript> myArray=["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]; WriteOutput("Input array is: "); WriteOutput(serializeJSON(myArray) & "|"); // Delete "Wednesday" at index 4 ArrayDeleteAt(myArray,4); // Returns True since the fourth position is a valid position in the array WriteOutput("Array after deleting the member at position four is: "); WriteOutput(serializeJSON(myArray)); // Array with "Wednesday" deleted </cfscript>