Skip to content

ArrayDimentionSize

Include: Use System\Reflection.pkg

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

Purpose

Returns the declared size for a fixed array dimension.

Syntax

Function ArrayDimentionSize Global Handle hArray Integer iDimention Returns Integer

Arguments

hArray : Array metadata handle.

iDimention : Zero-based dimension index. The API name and parameter spelling are Dimention.

Returns

The declared fixed-array dimension size, or 0 for dynamic array metadata.

Behavior

The API name and parameter spelling are Dimention. Dynamic array metadata returns 0 for dimension size. For fixed arrays, iDimention is zero-based. Out-of-range dimensions and invalid handles raise a DataFlex error.

Example

Integer[2][5] aiValues
Handle hArray
Integer iDims iSize
DfType eType

Get ArrayTypeOf aiValues to hArray
Get ArrayDimensionCount hArray to iDims
Get ArrayDimentionSize hArray 1 to iSize
Get ValueTypeOfArray hArray to eType