ArrayPrepend

Adds an array element to the beginning of the specified array. Returns a Boolean TRUE on successful completion.

Syntax

ArrayPrepend(array, value)

array

Name of the array to which you want to prepend data.

value

The value you want to add to the beginning of the specified array.

Examples

<!--- This example shows ArrayPrepend --->
<HTML>
<HEAD>
<TITLE>ArrayPrepend Example</TITLE>
</HEAD>

<BODY>
<H3>ArrayPrepend Example</H3>

<CFQUERY NAME="GetEmployeeNames" DATASOURCE="HRApp">
SELECT FirstName, LastName FROM Employees
</CFQUERY>
<!--- create an array --->
<CFSET myArray=ArrayNew(1)>
<!--- set element one to show where we are --->
<CFSET myArray[1]="Test Value">
<!--- loop through the query and append these names
successively before the last element (this list will
reverse itself from the standard queried output, as
it keeps prepending the array entry) --->
<CFLOOP query="GetEmployeeNames">
    <CFOUTPUT>#ArrayPrepend(myArray, "#FirstName# #LastName#")#</
CFOUTPUT>, Array was prepended<BR>
</CFLOOP>
<!--- show the resulting array as a list --->
<CFSET myList=ArrayToList(myArray, ",")>
<!--- output the array as a list --->
<CFOUTPUT>
    <P>The contents of the array are as follows:
    <P>#myList#
</CFOUTPUT>
</BODY>
</HTML>