Skip to content

    TFPGMapObject.Remove

    Remove a key from the list.

    Declaration

    Source position: fgl.pp line 409

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

    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

    Name Description
    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