arrayClear

Description

Deletes the data in an array.

Categories

Related

History

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

Syntax

ArrayClear(array)

Attributes

AttributeDescriptionRequiredDefault
arrayName of an array

Returns

True, on successful completion.

Example

<h3>ArrayClear Example</h3> 
<!--- Create a new array. ---> 
<cfset MyArray = ArrayNew(1)> 
<!--- Populate an element or two. ---> 
<cfset MyArray[1] = "Test"> 
<cfset MyArray[2] = "Other Test"> 
<!--- Output the contents of the array. ---> 
Your array contents are: 
<cfoutput>#ArrayToList(MyArray)#</cfoutput> 
<!--- Check to see if the array is empty. ---> 
Is the array empty?: 
<cfoutput>#ArrayIsEmpty(MyArray)#</cfoutput> 
Now, clear the array: 
<!--- Now clear the array. ---> 
<cfset Temp = ArrayClear(MyArray)> 
<!--- Check to see if the array is empty. ---> 
Is the array empty?: 
<cfoutput>#ArrayIsEmpty(MyArray)#</cfoutput>