set_dict_tuple — Add a key/tuple pair to the dictionary.
set_dict_tuple stores a tuple associated with a key in the
The dictionary is denoted by the
Tuple 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
If any data (tuple or object) was already associated with given key
Key), the old data is destroyed by
and replaced by
Key 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
If the tuple contains any handles only the handle values are copied by the operation, not the resources behind those handles (no deep copy is created).
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
DictHandle(input_control, state is modified) dict
Number of elements: DictHandle == 1
→(string / integer)
Number of elements: Key == 1
length(Key) > 0
→(string / integer / real / handle)
Tuple value to be associated with the key.
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')
If the operation succeeds,
set_dict_tuple returns 2 (H_MSG_TRUE).
Otherwise an exception is raised. Possible error conditions include
invalid parameters (handle or key) or resource allocation error.