Sign in Join
FPDoc Onlineexperiment

TBaseMap.InternalGetData function

Member of TBaseMapprotectedIn unit Maps

Gets the data stored in the specified map item.

Declaration

pascal
function InternalGetData(AItem: PMapItem; out AData): Boolean

Arguments

AItem

Map item to examine n the method.

AData

Data stored in the specified map item.

Function result

True when the specified map item is a valid pointer.

Description

InternalGetData is a Boolean function used to get the data stored in the specified map item. AItem is the map item examined in the method, and must contain a valid pointer. The return value is set to False, and no actions are performed in the method, when AItem contains Nil. The return value is True when a pointer has been assigned to AItem.

InternalGetData skips the ID value in AItem, and stores the Data for the map item in AData. The size arguments passed in the constructor are used when reading the ID and Data values. Please note that no validation is performed for the arbitrary byte values read into AData.

Do not call InternalGetData directly. Use the public methods in the class, or a descendant class like TMap which implements the GetData method.

See also

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