integer_to_handleT_integer_to_handleIntegerToHandleIntegerToHandle (Operator)

Name

integer_to_handleT_integer_to_handleIntegerToHandleIntegerToHandle — 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( : : IntegerHandle : Handle)

integer_to_handleinteger_to_handleIntegerToHandleIntegerToHandleIntegerToHandle converts the integer IntegerHandleIntegerHandleIntegerHandleIntegerHandleintegerHandle, that represents a handle, to a handle of type HANDLE_PAR and returns it in HandleHandleHandleHandlehandle. This allows to convert handles created in code parts where the legacy handle mode is enabled into proper handles.

If the legacy handle mode is disabled (the default), the ownership of the handle is transferred onto the handle. In this case, the handle will automatically be cleared once all references to that handle, such as in the tuple HandleHandleHandleHandlehandle, are overwritten. In that case, if the original IntegerHandleIntegerHandleIntegerHandleIntegerHandleintegerHandle should continue to be used, a reference to the returned HandleHandleHandleHandlehandle must be kept in order to avoid clearing the handle.

If the legacy handle mode is enabled, the returned value will again be an integer. Additionally, the handle must then be cleared using clear_handleclear_handleClearHandleClearHandleClearHandle or the clear operator of the corresponding semantic type of 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

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

IntegerHandleIntegerHandleIntegerHandleIntegerHandleintegerHandle (input_control) pointer(-array) → (integer)

The handle as integer.

HandleHandleHandleHandlehandle (output_control) handle(-array) → (handle)

The handle as handle.

Result

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

Module

Foundation

Operators