[Overview][Constants][Types][Classes][Index] | Reference for unit 'fgl' (#rtl)

# TFPGMapObject.Remove

Remove a key from the list

## Declaration

Source position: fgl.pp line 381

`public function TFPGMapObject.Remove(`
`const AKey: TKey`
`):Integer;`

## Arguments

`AKey` |  | Key to remove from the list.

## Function result

Index of AKey prior to removal.

## Description

Remove removes the key AKey from the list, together with its associated data. The function returns the index of AKey prior to removal from the list, or -1 if AKey was not present in the list.

## Errors

None.

## See also

TFPGMapObject.InsertKey |  | Insert a new key in the list
TFPGMapObject.InsertKeyData |  | Insert a new key with associated data in the list
TFPGMapObject.Add |  | Add a key and value to the map
TFPSMap.Delete

Documentation generated on: May 14 2021