set_dict_tupleT_set_dict_tupleSetDictTupleSetDictTuple (Operator)

Name

set_dict_tupleT_set_dict_tupleSetDictTupleSetDictTuple — Add a key/tuple pair to the dictionary.

Signature

set_dict_tuple( : : DictHandle, Key, Tuple : )

Description

set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTuple stores a tuple associated with a key in the dictionary. The dictionary is denoted by the DictHandleDictHandleDictHandleDictHandledictHandle parameter.

TupleTupleTupleTupletuple including strings is copied by the operation, and can thus be immediately reused. An empty tuple is considered as a valid value that can be associated with the key. If any data (tuple or object) was already associated with given key (KeyKeyKeyKeykey), the old data is destroyed by set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTuple and replaced by TupleTupleTupleTupletuple.

The KeyKeyKeyKeykey has to be a string or an integer. Strings are treated case sensitive.

The tuple data for the given key can be retrieved again from the dictionary using get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTuple.

Attention

Note that if the tuple contains any handles (which are treated as simple integers) only the handle values are copied by the operation, not the resources behind those handles.

Execution Information

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

This operator modifies the state of the following input parameter:

DictHandleDictHandleDictHandleDictHandledictHandle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

DictHandleDictHandleDictHandleDictHandledictHandle (input_control, state is modified) dict → (handle)

Dictionary handle.

Number of elements: DictHandle == 1

KeyKeyKeyKeykey (input_control) string → (string / integer)

Key string.

Number of elements: Key == 1

Restriction: length(Key) > 0

TupleTupleTupleTupletuple (input_control) tuple-array → (string / integer / real)

Tuple value to be associated with the key.

Example (HDevelop)

create_dict (Dict)
set_dict_tuple (Dict, 'simple_integer', 27)
set_dict_tuple (Dict, 'simple_string', 'Hello world')
set_dict_tuple (Dict, 'mixed_tuple', ['The answer', 42])
set_dict_tuple (Dict, 0, 'This is zero')

Result

If the operation succeeds, set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTuple returns 2 (H_MSG_TRUE). Otherwise an exception is raised. Possible error conditions include invalid parameters (handle or key) or resource allocation error.