ArrayStart
(Engine-Level Function)
Description: |
Returns the index of the first element in an array dimension. |
Returns: | Numeric |
Usage: | Script or steady state. |
Related to: | ArrayDimensions | ArraySize| Array Functions |
Function Groups: | Array |
Format: | ArrayStart(Array, Dimension) |
Parameters: |
Array |
Required. Any array variable. |
Dimension |
Required. Any numeric expression that gives the array dimension to examine. |
Comments: |
When creating arrays, it is recommended to always start all dimensions at 0. which is the default, and is how all arrays produced by VTScada APIs are constructed. You will not normally need to use this function. If dealing with code where you cannot be sure of that, the ArrayStart can help you discover the non-standard starting index. |