get_handle_objectT_get_handle_objectGetHandleObjectGetHandleObject (Operator)

Name

get_handle_objectT_get_handle_objectGetHandleObjectGetHandleObject — Retrieve an object associated with a key from a handle.

Signature

get_handle_object( : Object : Handle, Key : )

Herror T_get_handle_object(Hobject* Object, const Htuple Handle, const Htuple Key)

void GetHandleObject(HObject* Object, const HTuple& Handle, const HTuple& Key)

static void HOperatorSet.GetHandleObject(out HObject objectVal, HTuple handle, HTuple key)

Description

get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject retrieves an iconic object associated with the KeyKeyKeyKeykey from HandleHandleHandleHandlehandle and returns it in ObjectObjectObjectObjectobjectVal. The list of keys supported by a handle can be queried with get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParam.

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_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParams, get_shape_model_paramsget_shape_model_paramsGetShapeModelParamsGetShapeModelParamsGetShapeModelParams etc.

Execution Information

Parameters

ObjectObjectObjectObjectobjectVal (output_object)  object(-array) objectHObjectHObjectHobject *

Iconic value of the key.

HandleHandleHandleHandlehandle (input_control)  handle HHandle, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of which to get the key.

KeyKeyKeyKeykey (input_control)  string HTupleHTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Key to get.

Result

If the parameters are valid, the operator get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.

Alternatives

get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple

See also

get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParam

Module

Foundation