handle_to_integer — Convert a handle into an integer.
It is not recommended to use this operator in HDevelop. This operator is only provided for reasons of backward compatibility.
handle_to_integer( : : Handle : CastedHandle)
handle_to_integer converts the handle Handle into an
integer representation and returns it in CastedHandle.
If the legacy handle mode is disabled (the default), the ownership of the
handle is not transferred. Once all instances of the handle, such as in the tuple
Handle, were overwritten, the handle and its content will be
destroyed and CastedHandle will become invalid.
In that case, if CastedHandle should be passed to code parts that
run in legacy handle mode, a reference to the original Handle must
be kept in order to avoid clearing the handle.
If the legacy handle mode is enabled, the ownership of the handle is
transferred. The handle must then be cleared using clear_handle
or the clear operator of the corresponding semantic type of the handle.
It is not recommended to use this operator in HDevelop. It is solely provided to enable backward compatibility with legacy code.
Handle (input_control) handle(-array) → (handle)
The handle to be cast.
CastedHandle (output_control) pointer(-array) → (integer)
The handle cast to an integer value.
If the parameters are valid, the operator handle_to_integer
returns the value 2 (
H_MSG_TRUE)
. Otherwise, an exception is raised.
Foundation