Skip to content

integer_to_handleIntegerToHandleIntegerToHandleinteger_to_handleT_integer_to_handle🔗

Short description🔗

integer_to_handleIntegerToHandleIntegerToHandleinteger_to_handleT_integer_to_handle — Convert an integer into a handle.

Warning🔗

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

Signature🔗

integer_to_handle( pointer IntegerHandle, out handle Handle )void IntegerToHandle( const HTuple& IntegerHandle, HTuple* Handle )static void HOperatorSet.IntegerToHandle( HTuple integerHandle, out HTuple handle )def integer_to_handle( integer_handle: MaybeSequence[int] ) -> Sequence[HHandle]

def integer_to_handle_s( integer_handle: MaybeSequence[int] ) -> HHandleHerror T_integer_to_handle( const Htuple IntegerHandle, Htuple* Handle )

Description🔗

integer_to_handleIntegerToHandle converts the integer IntegerHandleintegerHandleinteger_handle, that represents a handle, to a handle of type HANDLE_PAR and returns it in Handlehandlehandle.

The ownership of the handle is transferred onto the handle. The handle will automatically be cleared once all references to that handle, such as in the tuple Handlehandlehandle, are overwritten. If the original IntegerHandleintegerHandleinteger_handle should continue to be used, a reference to the returned Handlehandlehandle must be kept in order to avoid clearing the handle.

Attention🔗

It is not recommended to use this operator in HDevelop. This operator 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.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters🔗

IntegerHandleintegerHandleinteger_handle (input_control) pointer(-array) → (integer)HTuple (Hlong)HTuple (IntPtr)MaybeSequence[int]Htuple (Hlong)

The handle as integer.

Handlehandlehandle (output_control) handle(-array) → (handle)HTuple (HHandle)HHandle, HTuple (IntPtr)Sequence[HHandle]Htuple (handle)

The handle as handle.

Result🔗

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

Combinations with other operators🔗

Combinations

See also

handle_to_integerHandleToInteger

Module🔗

Foundation