handle_to_integerT_handle_to_integerHandleToIntegerHandleToIntegerhandle_to_integer (Operator)
Name
handle_to_integerT_handle_to_integerHandleToIntegerHandleToIntegerhandle_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
def handle_to_integer(handle: MaybeSequence[HHandle]) -> Sequence[int]
def handle_to_integer_s(handle: MaybeSequence[HHandle]) -> int
Description
handle_to_integerhandle_to_integerHandleToIntegerHandleToIntegerhandle_to_integer converts the handle HandleHandleHandlehandlehandle into an
integer representation and returns it in CastedHandleCastedHandleCastedHandlecastedHandlecasted_handle.
The ownership of the handle is not transferred. Once all instances of the
handle, such as in the tuple HandleHandleHandlehandlehandle, were overwritten, the handle
and its content will be destroyed and CastedHandleCastedHandleCastedHandlecastedHandlecasted_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
- 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(-array) → HHandle, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
The handle to be cast.
CastedHandleCastedHandleCastedHandlecastedHandlecasted_handle (output_control) pointer(-array) → HTupleSequence[int]HTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)
The handle cast to an integer value.
Result
If the parameters are valid, the operator handle_to_integerhandle_to_integerHandleToIntegerHandleToIntegerhandle_to_integer
returns the value 2 (
H_MSG_TRUE)
. Otherwise, an exception is raised.
See also
integer_to_handleinteger_to_handleIntegerToHandleIntegerToHandleinteger_to_handle
Module
Foundation