get_handle_object🔗
Short description🔗
get_handle_object — Retrieve an object associated with a key from a handle.
Signature🔗
get_handle_object( out object Object, handle Handle, string Key )
Description🔗
get_handle_object retrieves an iconic object associated with the
Key from Handle and returns it in Object.
The list of keys supported by a handle can be queried with
get_handle_param.
Note that this operator is provided only for implementing generic
debug and inspection mechanisms.
The keys returned for certain handle types can change without notice.
Additionally, some handle types might not be supported by this operator.
Also, this operator is not optimized for performance.
To obtain more reliable information about a handle in a program, it is
strongly recommended to use the operators specialized for the particular
handle type, such as get_object_model_3d_params,
get_generic_shape_model_param etc.
Execution information🔗
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🔗
Object (output_object) object(-array) → object
Iconic value of the key.
Handle (input_control) handle → (handle)
Handle of which to get the key.
Key (input_control) string → (string / integer)
Key to get.
Result🔗
If the parameters are valid, the operator get_handle_object
returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.
Combinations with other operators🔗
Module🔗
Foundation