get_handle_objectT_get_handle_objectGetHandleObjectGetHandleObjectget_handle_object (Operator)
Name
get_handle_objectT_get_handle_objectGetHandleObjectGetHandleObjectget_handle_object — Retrieve an object associated with a key from a handle.
Signature
Herror T_get_handle_object(Hobject* Object, const Htuple Handle, const Htuple Key)
void GetHandleObject(HObject* Object, const HTuple& Handle, const HTuple& Key)
def get_handle_object(handle: HHandle, key: Union[str, int]) -> HObject
Description
get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object retrieves an iconic object associated with the
KeyKeyKeyKeykeykey from HandleHandleHandleHandlehandlehandle and returns it in ObjectObjectObjectObjectobjectValobject.
The list of keys supported by a handle can be queried with
get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParamget_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_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParamsget_object_model_3d_params,
get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param etc.
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
ObjectObjectObjectObjectobjectValobject (output_object) object(-array) → objectHObjectHObjectHObjectHobject *
Iconic value of the key.
HandleHandleHandleHandlehandlehandle (input_control) handle → HHandle, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of which to get the key.
KeyKeyKeyKeykeykey (input_control) string → HTupleUnion[str, int]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)
Key to get.
Result
If the parameters are valid, the operator get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObjectget_handle_object
returns the value 2 (
H_MSG_TRUE)
. Otherwise, an exception is raised.
Alternatives
get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTupleget_handle_tuple
See also
get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParamget_handle_param
Module
Foundation