FPDoc Onlineexperiment

VarArrayHighBound function

In unit Variants

Return lower bound of an array.

Declaration

pascal

function VarArrayHighBound(const A: Variant; Dim: LongInt): LongInt

Arguments

`A`	Array to check.
`Dim`	Dimension to check.

Function result

High bound of the dimension Dim.

Description

VarArrayHighBound returns the high bound (max index) of dimension Dim of array A. The dimension Dim is 1-based.

Errors

If the dimension is out of range, or A is not a variant array, an exception will be raised.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.