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.
|
|
Returns
|
True, on successful completion.
|
|
Category
|
Array functions
|
|
Function syntax |
ArraySet(array, start_pos, end_pos, value)
|
|
See also
|
ArrayNew
|
|
History
|
ColdFusion MX: Changed behavior: this function can be used on XML objects.
|
|
Parameters
|
|
Parameter |
Description |
array |
Name of an array. |
start_pos |
Starting index position of range to set. |
end_pos |
Ending index position of range to set. If this value is greater than array length, |
|
ColdFusion adds elements to array. |
value |
Value to which to set each element in the range. |
|
|
Example<h3>ArraySet Example</h3>
<!--- Make 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">
...
|