get_handle_tupleGetHandleTupleGetHandleTupleget_handle_tupleT_get_handle_tuple

HALCON ScriptCpp++.NETPythonC

Short description

get_handle_tupleGetHandleTupleGetHandleTupleget_handle_tupleT_get_handle_tuple — Retrieve a tuple associated with a key from a handle.

Signature

get_handle_tuple( handle Handle, string Key, out tuple Tuple )void GetHandleTuple( const HTuple& Handle, const HTuple& Key, HTuple* Tuple )static void HOperatorSet.GetHandleTuple( HTuple handle, HTuple key, out HTuple tuple )def get_handle_tuple( handle: HHandle, key: Union[str, int] ) -> Sequence[Union[int, float, str]]

def get_handle_tuple_s( handle: HHandle, key: Union[str, int] ) -> Union[int, float, str]Herror T_get_handle_tuple( const Htuple Handle, const Htuple Key, Htuple* Tuple )

Description

get_handle_tupleGetHandleTuple retrieves a tuple associated with the Keykeykey from Handlehandlehandle and returns it in Tupletupletuple. The list of keys supported by a handle can be queried with get_handle_paramGetHandleParam.

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_paramsGetObjectModel3dParams, get_generic_shape_model_paramGetGenericShapeModelParam 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

Handlehandlehandle (input_control) handle → (handle)HTuple (HHandle)HHandle, HTuple (IntPtr)HHandleHtuple (handle)

Handle of which to get the key.

Keykeykey (input_control) string → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)Union[str, int]Htuple (char* / Hlong)

Key to get.

Number of elements: Key == 1
Restriction: length(Key) > 0

Tupletupletuple (output_control) tuple(-array) → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Sequence[Union[int, float, str]]Htuple (char* / Hlong / double)

Control value of the key.

Result

If the parameters are valid, the operator get_handle_tupleGetHandleTuple returns the value 2 (H_MSG_TRUE). If the handle is invalid or does not support the given key, or if the key references an iconic object instead of a tuple, an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

get_handle_paramGetHandleParam

Alternatives

get_handle_objectGetHandleObject

See also

get_handle_paramGetHandleParam, get_handle_objectGetHandleObject

Module

Foundation