TBaseMap.InternalGetId function

Member of TBaseMapprotectedIn unit Maps

Get the ID value for the specified map item.

Declaration

pascal

function InternalGetId(AItem: PMapItem; out AID): Boolean

Arguments

`AItem`	Map item examined in the method.
`AID`	Value for the ID in the specified map item.

Function result

False if the specified map item is not a valid Pointer.

Description

InternalGetId is a Boolean function used to get the ID value for the specified map item. AItem is a Pointer to the map item examined in the method. The return value is False if AItem has not been assigned (contains Nil), and no actions are performed in the method.

InternalGetId stores the ID value from AItem in the AID parameter. The number of bytes used for the ID is specified using a TMapIdType value in the constructor for the class.

InternalGetID is used primarily in the implementation of TBaseMapIterator and descendant classes.

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