Sign in Join
FPDoc Onlineexperiment

TFPHashObjectList.Remove function

Member of TFPHashObjectListpublicIn unit Contnrs

Remove first occurrence of a object instance.

Declaration

pascal
function Remove(AObject: TObject): Integer

Arguments

AObject

Object instance to remove from the list.

Function result

Position of object instance which was removed.

Description

Remove removes the first occurrence of the object instance Item in the list, if it is present. The return value is the location of the removed object instance, or -1 if no object instance was removed.

If OwnsObjects is True, then the object itself is also freed from memory.

See also

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