Sign in Join
FPDoc Onlineexperiment

TFPSMap.Insert function

Member of TFPSMappublicIn unit fgl

Insert a new slot for key and associated data item in the list.

Declaration

pascal
function Insert(Index: Integer): Pointer
procedure Insert(Index: Integer; out AKey: Pointer; out AData: Pointer)

Arguments

Index

Index to insert new key, value pair.

AKey

Pointer to location for key value.

AData

Pointer to location for data value.

Function result

Slot to add data to.

Description

Insert will allocate a new slot in the list. It returns a pointer to the new slot. If Akey and AData are given, then they will point to the positions in the slot for the key and data items.

Errors

If the maximum amount of values is reached or an invalid index is specified, Insert will raise an EListError exception.

See also

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