View source for Array SetMaxIndex

Resizes a declared dynamic array to a specified number of elements; returns a value of [[True]] to indicate a successful resize. 
An array can be resized to a larger or to a smaller number of elements; any elements added to an array will be assigned the initial value that was specified at array declaration. 
 
== Usage ==
<syntaxhighlight>Array_SetMaxIndex(ArrayName,MaxIndex)</syntaxhighlight> 

Where: 
:'''ArrayName''' - an expression specifying the name of an array to be resized 
             
:'''MaxIndex''' - a numerical expression specifying the maximum index of the array* 

[[*]]Array indexes start at 0, and array size is equal to the value of MaxIndex plus one. 

== Return == 
[[True]] - resize sucessfull 

[[False]] - resize failed 
 
== Example ==
Resize the dynamic array Array1 to 10 elements by specifying a maximum index value of 9: 

<syntaxhighlight>Array_SetMaxIndex(Array1,9);</syntaxhighlight> 

Assign a value that indicates a status of the resize of Array1 to the ResizeReport variable: 

<syntaxhighlight>ResizeReport=Array_SetMaxIndex(Array1,9);</syntaxhighlight> 

A value of True will indicate a successful resize, and a value of False will indicate a failed resize. 
 

[[Category:Dynamic Arrays]]