get_handle_paramT_get_handle_paramGetHandleParamGetHandleParam (Operator)

Name

get_handle_paramT_get_handle_paramGetHandleParamGetHandleParam — Return information about a handle.

Signature

get_handle_param( : : Handle, GenParamName, Key : GenParamValue)

Description

get_handle_paramget_handle_paramGetHandleParamGetHandleParamGetHandleParam returns details about HandleHandleHandleHandlehandle in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. It provides a generic mechanism for inspecting and debugging handles of any type by returning keys of that handle that can later be queried using get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple and get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject.

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.

Depending on the value of GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the following values can be queried:

'keys'"keys""keys""keys""keys":: Returns a list of keys that this handle supports in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. Each key contains either a tuple or an iconic object. For this query, the parameter KeyKeyKeyKeykey must be empty. Note that due to the generic nature of this operator, some of the returned keys might not be valid for the particular handle. In this case, get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple or get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject will return an error for those keys.
'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type":: Returns the data type of KeyKeyKeyKeykey. The type is returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue and is either 'tuple'"tuple""tuple""tuple""tuple" or 'object'"object""object""object""object". Depending on the type, the key's corresponding value can be queried with get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple or get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject, respectively.

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

HandleHandleHandleHandlehandle (input_control) handle → (handle)

Handle of which to get the parameter.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) string → (string)

Parameter to get.

Default value: 'keys' "keys" "keys" "keys" "keys"

List of values: 'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type", 'keys'"keys""keys""keys""keys"

KeyKeyKeyKeykey (input_control) string(-array) → (string)

Optional key.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control) tuple(-array) → (string / integer / real)

Returned value.

Result

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

Possible Successors

clear_handleclear_handleClearHandleClearHandleClearHandle, get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleGetHandleTuple, get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectGetHandleObject

Module

Foundation

Operators