Sign in Join
FPDoc Onlineexperiment

TObjectList.Extract function

Member of TObjectListpublicIn unit Contnrs

Extract an object from the list.

Declaration

pascal
function Extract(Item: TObject): TObject

Arguments

Item

Element to remove from the list.

Function result

The removed element, or Nil.

Description

Extract removes the object Item from the list if it is present in the list. Contrary to Remove, Extract does not free the extracted element if OwnsObjects is True

The function returns a reference to the item which was removed from the list, or Nil if no element was removed.

Errors

None.

See also

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