Skip to content

handle_to_integerHandleToIntegerHandleToIntegerhandle_to_integerT_handle_to_integer🔗

Short description🔗

handle_to_integerHandleToIntegerHandleToIntegerhandle_to_integerT_handle_to_integer — Convert a handle into an integer.

Warning🔗

It is not recommended to use this operator in HDevelop. This operator is only provided for reasons of backward compatibility.

Signature🔗

handle_to_integer( handle Handle, out pointer CastedHandle )void HandleToInteger( const HTuple& Handle, HTuple* CastedHandle )static void HOperatorSet.HandleToInteger( HTuple handle, out HTuple castedHandle )def handle_to_integer( handle: MaybeSequence[HHandle] ) -> Sequence[int]

def handle_to_integer_s( handle: MaybeSequence[HHandle] ) -> intHerror T_handle_to_integer( const Htuple Handle, Htuple* CastedHandle )

Description🔗

handle_to_integerHandleToInteger converts the handle Handlehandlehandle into an integer representation and returns it in CastedHandlecastedHandlecasted_handle.

The ownership of the handle is not transferred. Once all instances of the handle, such as in the tuple Handlehandlehandle, were overwritten, the handle and its content will be destroyed and CastedHandlecastedHandlecasted_handle will become invalid.

Attention🔗

It is not recommended to use this operator in HDevelop. It is solely provided to enable backward compatibility with legacy code.

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(-array) → (handle)HTuple (HHandle)HHandle, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

The handle to be cast.

CastedHandlecastedHandlecasted_handle (output_control) pointer(-array) → (integer)HTuple (Hlong)HTuple (IntPtr)Sequence[int]Htuple (Hlong)

The handle cast to an integer value.

Result🔗

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

Combinations with other operators🔗

Combinations

See also

integer_to_handleIntegerToHandle

Module🔗

Foundation