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
def get_dict_tuple(dict_handle: HHandle, key: Union[str, int]) -> Sequence[Union[int, float, str]]
def get_dict_tuple_s(dict_handle: HHandle, key: Union[str, int]) -> Union[int, float, str]
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
.
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 →
HDict, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Dictionary handle.
Number of elements: DictHandle == 1
KeyKeyKeyKeykeykey
(input_control) string →
HTupleUnion[str, int]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)
Key string.
Number of elements: Key == 1
Restriction: length(Key) > 0
TupleTupleTupleTupletupletuple
(output_control) tuple(-array) →
HTupleSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
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)
Result
If the operation succeeds, get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_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.
Possible Predecessors
set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple
Alternatives
get_dict_objectget_dict_objectGetDictObjectGetDictObjectGetDictObjectget_dict_object
See also
create_dictcreate_dictCreateDictCreateDictCreateDictcreate_dict
,
set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple
,
set_dict_objectset_dict_objectSetDictObjectSetDictObjectSetDictObjectset_dict_object
,
get_dict_objectget_dict_objectGetDictObjectGetDictObjectGetDictObjectget_dict_object
,
remove_dict_keyremove_dict_keyRemoveDictKeyRemoveDictKeyRemoveDictKeyremove_dict_key
,
get_dict_paramget_dict_paramGetDictParamGetDictParamGetDictParamget_dict_param
Module
Foundation