This function returns the value of key a from the map (see Token list, list, map) with name b.
The return value can be a list of values separated by a delimiter (token list). In this case, parameter c reduces the return value to one element of the list. Parameter c defines the list delimiter. Parameter d defines the numeric position in the token list, starting at 1. See examples.
The return value is the default value e in the following cases: There is no map with name b. Or the map does not contain key a. Or there is no token d.
NOTE: If the map contains 'hidden' values, the function returns them as such. See the explanations for the Empty Flag.
NOTE: If the map holds an Inheritance value, the function returns only the currently visible value.
NOTE: If map b does not exist yet, the function creates it automatically as empty. For details, see Token list, list, map.
Parameters
Parameter | Description |
|---|---|
a | Key value. |
b | Name of the map. |
c | (optional) Delimiter within the return value. The function interprets the value as hexadecimal if it starts with 0x. |
d | (optional) Position within the return value (starting at 1). For -1, the function uses the current iteration-level(). |
e | (optional) Default value if no other value is found. |
f | (optional) Character that masks the delimiter in the return value. If this character occurs in the return value before the delimiter defined in c, the function does not interpret this character sequence as a delimiter. |
Examples
Assume we have a map myMap with the values {key1=value, key2=val1;val2, key3=Main St\; Suite 5;Second Line}.
Parameter a | Parameter b | Parameter c | Parameter d | Parameter e | Parameter f | Result |
|---|---|---|---|---|---|---|
key1 | myMap | value | ||||
key2 | myMap | val1;val2 | ||||
key2 | myMap | ; | 2 | val2 | ||
key2 | myMap | ; | 3 | |||
key2 | myMap | ; | 3 | somevalue | somevalue | |
key | myMap | |||||
key | myMap | somevalue | somevalue | |||
key1 | myOtherMap | |||||
key3 | myMap | ; | 1 | Main St\ | ||
key3 | myMap | ; | 1 | \ | Main St\; Suite 5 | |
key3 | myMap | ; | 2 | \ | Second Line |