get_dict_tuple — Retrieve a tuple associated with the key from the dictionary.
get_dict_tuple( : : DictHandle, Key : Tuple)
get_dict_tuple retrieves a tuple associated with the Key
from the dictionary denoted by the DictHandle.
The tuple has to be previously stored to the dictionary using
set_dict_tuple.
The operator returns the data in the parameter Tuple.
The data including strings is copied by the operation, the dictionary can
thus be immediately reused.
If the given Key is not present in the dictionary or if the data
associated with the key is not a tuple, get_dict_tuple fails.
Presence of keys and information about the data associated with the key
can be verified using get_dict_param.
DictHandle (input_control) dict → (handle)
Dictionary handle.
Number of elements: DictHandle == 1
Key (input_control) string → (string / integer)
Key string.
Number of elements: Key == 1
Restriction: length(Key) > 0
Tuple (output_control) tuple(-array) → (string / integer / real)
Tuple value retrieved from the dictionary.
* ...
get_dict_param (Dict, 'key_exists', ['simple_string','foo','my_image'], \
KeysPresence)
get_dict_param (Dict, 'key_data_type', ['simple_string','my_image'], \
KeysType)
get_dict_tuple (Dict, 'simple_string', TupleString)
If the operation succeeds, get_dict_tuple returns 2 (H_MSG_TRUE).
Otherwise an exception is raised. Possible error conditions include
invalid parameters (handle or key), the required key not found in the
dictionary, or other than tuple data associated with given key.
create_dict,
set_dict_tuple,
set_dict_object,
get_dict_object,
remove_dict_key,
get_dict_param
Foundation