create_dictT_create_dictCreateDictCreateDictcreate_dict (Operator)

Name

create_dictT_create_dictCreateDictCreateDictcreate_dict — Create a new empty dictionary.

Signature

Description

create_dictcreate_dictCreateDictCreateDictCreateDictcreate_dict creates a new empty dictionary and returns it in DictHandleDictHandleDictHandleDictHandledictHandledict_handle.

The dictionary serves as an associative array-like container allowing to store an arbitrary number of values associated with unique keys (integers or strings). Each key can refer either to a tuple or to an iconic object. These are stored in the dictionary using set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple or set_dict_objectset_dict_objectSetDictObjectSetDictObjectSetDictObjectset_dict_object, respectively, from where they can be retrieved again using get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_dict_tuple or get_dict_objectget_dict_objectGetDictObjectGetDictObjectGetDictObjectget_dict_object.

The data stored in the dictionary is always a copy of the original data, being it control parameters or objects. The original data can thus be reused immediately after the set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple or set_dict_objectset_dict_objectSetDictObjectSetDictObjectSetDictObjectset_dict_object calls. The following particularities apply:

• Objects: The copy is a reference, as in copy_objcopy_objCopyObjCopyObjCopyObjcopy_obj. In particular, changes made using the operators set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayvalset_grayval or overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionOverpaintRegionoverpaint_region affect the object stored in the Dictionary as well.

• Handles: Storing any handle in the dictionary will copy the handle value, but not the resource behind the handle.

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 returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

Example (HDevelop)

Dicts := []
for idx := 0 to 4 by 1
  create_dict (DictHandle)
  Dicts[idx] := DictHandle
endfor
* ...

Result

Returns 2 (H_MSG_TRUE) unless a resource allocation error occurs.

Possible Successors

set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple, set_dict_objectset_dict_objectSetDictObjectSetDictObjectSetDictObjectset_dict_object

See also

set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple, get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_dict_tuple, set_dict_objectset_dict_objectSetDictObjectSetDictObjectSetDictObjectset_dict_object, get_dict_objectget_dict_objectGetDictObjectGetDictObjectGetDictObjectget_dict_object, get_dict_paramget_dict_paramGetDictParamGetDictParamGetDictParamget_dict_param

Module

Foundation