Sign in Join
FPDoc Onlineexperiment

TFPObjectList.Extract function

Member of TFPObjectListpublicIn unit Contnrs

Extract an object from the list.

Declaration

pascal
function Extract(Item: TObject): TObject

Arguments

Item

The object to extract.

Function result

The extracted object, or Nil if none was extracted.

Description

Extract removes Item from the list, if it is present in the list. It returns Item if it was found, Nil if item was not present in the list.

Note that the object is not freed, and that only the first found object is removed from the list.

Errors

None.

See also

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