[Overview][Resource strings][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'tiObject' (#tiopf)

TtiObjectList.Remove

Removes the specified item from the list and (if OwnsObject is True) frees the object

Declaration

Source position: tiObject.pas line 636

public function TtiObjectList.Remove(

  const AObject: TtiObject

):Integer; virtual;

Description

Call Remove to delete a specific object from the list when its index is unknown. The value returned is the index of the object in the Items array before it was removed. If the specified object is not found on the list, Remove returns -1. If OwnsObjects is True, Remove frees the object in addition to removing it from the list. After an object is deleted, all the objects that follow it are moved up in index position and Count is decremented. If an object appears more than once on the list, Remove deletes only the first appearance. Hence, if OwnsObjects is True, removing an object that appears more than once results in empty object references later in the list. To use an index position (rather than an object reference) to specify the object to be removed, call Delete. To remove an object from the list without freeing it, call Extract.

See also

TtiObjectList.OwnsObjects

  

Does the list own the objects it contains?

TtiObjectList.Delete

  

Removes the object at a specified position and (if OwnsObject is True) frees the object

TtiObjectList.Extract

  

Removes the specified object from the list without freeing the object


Documentation generated on: 2017-08-16