TFPGMap.Remove function

Member of TFPGMappublicIn unit fgl

Remove a key from the list.

Declaration

pascal

function 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.