TComponentList.Remove function

Member of TComponentListpublicIn unit Contnrs

Remove a component from the list, possibly destroying it.

Declaration

pascal

function Remove(AComponent: TComponent): Integer

Arguments

AComponent

Component to remove from the list.

Function result

The index of the removed instance.

Description

Remove removes item from the list, and if the list owns it's items, it also destroys it. It returns the index of the item that was removed, or -1 if no item was removed.

Remove simply overrides the implementation in TObjectList so it only accepts TComponent descendents. It introduces no new behaviour.

Errors

None.