Sign in Join
FPDoc Onlineexperiment

TCustomListBox.CheckIndex procedure

Member of TCustomListBoxprotectedIn unit StdCtrls

Ensures that the Item index is within the bounds for the Items in the control.

Declaration

pascal
procedure CheckIndex(const AIndex: Integer)

Arguments

AIndex

Index position examined in the method.

Description

CheckIndex is a procedure used to ensure that the specified index value is within the range of values allowed for the Items in the control. CheckIndex examines the value in AIndex, and raises an IndexOutOfBounds exception if it is not in the range 0 (zero) to Items.Count-1.

CheckIndex is used in the access specifiers for the Selected property (GetSelected, SetSelected).

Errors

Raises an IndexOutOfBounds exception when the index is out of bounds.

See also

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