MapExists

Cicode Programming Reference > Cicode Function Categories > Map Functions > MapExists

MapExists

Checks for the existence of the map.

Syntax

INT MapExists(STRING sMapName)

sMapName:

Name of the map.

Return Value

TRUE if the map exists, or FALSE if not.

If the map or key name is empty an “Invalid argument” error (274) will be raised.

Example

! Demonstrate MapExists.
STRING sMapName = MapOpen();
! sMapName is a randomly generated text that uniquely identifies the map
INT iMapExistsResultExpectTrue = MapExists(sMapName);
! iMapExistsResultExpectTrue will be set to TRUE (non-zero)
INT iMapCloseResult = MapClose(sMapName);
! The map that is identified by sMapName is now closed and unavailable
INT iMapExistsResultExpectFalse = MapExists(sMapName);
! iMapExistsResultExpectFalse will be set to FALSE (zero)

Related Functions

MapClear, MapOpen, MapClose, MapKeyCount, MapKeyDelete,MapKeyExists, MapKeyFirst, MapValueGet, MapKeyNext, MapValueSet, MapValueSetQuality