Skip to content

ArrayElementByIndex

Include: Use System\Reflection.pkg

See Also: ArrayTypeOf, ArrayDimensionCount, ArrayDimentionSize, ValueTypeOfArray, ArrayInstanceSize, SetArrayElementByIndex

Purpose

Returns an array element by zero-based index.

Syntax

Function ArrayElementByIndex Global Variant vArray Integer iIndex Returns Variant

Arguments

vArray : Array value to read.

iIndex : Zero-based element index.

Returns

The selected array element as a Variant.

Behavior

Wrong value types, fixed-array indexes outside the declared size, and overreach cases raise a DataFlex error. Nested struct or array elements are returned as Variant values.

Example

String[] asNames
Integer iSize
Variant vName

Move "Ada" to asNames[0]
Get ArrayInstanceSize asNames to iSize
Get ArrayElementByIndex asNames 0 to vName
Send SetArrayElementByIndex (&asNames) 0 "Grace"