Name GetMappingItem
Type Method
Summary Gets one item from the auto-map sequence
Prototype VARIANT GetMappingItem(long Item);
Description Returns one item from the auto-map sequence. You supply the item number that you want.

It should be in the range zero to the value returned by GetMappingCount, minus 1. If not, a NULL variant will be returned.

The item number is zero relative, so that if you have two items in the map sequence, they will be:

0: first item
1: second item

The returned value is a single string, with the forwards and reverse direction separated by a slash. For example:

north/south
VBscript example
world.note world.GetMappingItem (0)
Jscript example
world.note(world.GetMappingItem(0));
PerlScript example
$world->note($world->GetMappingItem(0));
Returns If the item number is less than zero, or greater than, or equal to, the number returned by GetMappingCount, then a NULL variant will be returned.

Otherwise, the contents of the appropriate map item will be returned. The forwards and reverse direction will be separated by the "/" character.

See also ...