get_dict_tupleT_get_dict_tupleGetDictTupleGetDictTupleget_dict_tuple (Operator)

Name

get_dict_tupleT_get_dict_tupleGetDictTupleGetDictTupleget_dict_tuple — Retrieve a tuple associated with the key from the dictionary.

Signature

get_dict_tuple( : : DictHandle, Key : Tuple)

Description

get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_dict_tuple retrieves a tuple associated with the KeyKeyKeyKeykeykey from the dictionary denoted by the DictHandleDictHandleDictHandleDictHandledictHandledict_handle. The tuple has to be previously stored to the dictionary using set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple.

The operator returns the data in the parameter TupleTupleTupleTupletupletuple. The data including strings is copied by the operation, the dictionary can thus be immediately reused.

If the given KeyKeyKeyKeykeykey is not present in the dictionary or if the data associated with the key is not a tuple, get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_dict_tuple fails. Presence of keys and information about the data associated with the key can be verified using get_dict_paramget_dict_paramGetDictParamGetDictParamGetDictParamget_dict_param.

Obtaining the values for multiple keys at once is only possible if for each of those keys, the dictionary contains a tuple with a single element.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

DictHandleDictHandleDictHandleDictHandledictHandledict_handle (input_control) dict → (handle)

Dictionary handle.

Number of elements: DictHandle == 1

KeyKeyKeyKeykeykey (input_control) string(-array) → (string / integer)

Key string.

TupleTupleTupleTupletupletuple (output_control) tuple(-array) → (string / integer / real)

Tuple value retrieved from the dictionary.

Example (HDevelop)

* ...
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)
*
* Access multiple keys, if their tuple all have length 1
get_dict_tuple (Dict, ['key1','key2','key3'], MultipleValues)

Result

If the operation succeeds, get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_dict_tuple returns 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.