arraySet

Description

In a one-dimensional array, sets the elements in a specified index range to a value. Useful for initializing an array after a call to ArrayNew.

History

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

Syntax

ArraySet(array, start_pos, end_pos, value)

Attributes

Attribute	Description	Required	Default
array	Name of an array.
end_pos	Ending index position of range to set. If this value is greater than array length, ColdFusion adds elements to array.
start_pos	Starting index position of range to set.
value	Value to which to set each element in the range.

Returns

True, on successful completion.

Example

<h3>ArraySet Example</h3> 
 
<!--- Create an array. ---> 
<cfset MyNewArray = ArrayNew(1)> 
<!--- ArrayToList does not function properly if the Array has not been initialized 
    with ArraySet. ---> 
<cfset temp = ArraySet(MyNewArray, 1,6, "Initial Value")> 
 
<!--- Set some elements. ---> 
<cfset MyNewArray[1] = "Sample Value"> 
<cfset MyNewArray[3] = "43"> 
<cfset MyNewArray[6] = "Another Value"> 
...

cfmldocs