tuple_is_handle🔗
Short description🔗
tuple_is_handle — Test if the internal representation of a tuple is of type handle.
Signature🔗
tuple_is_handle( tuple T, out number IsHandle )
Description🔗
tuple_is_handle tests if the internal representation of the
input tuple T is of type handle. In that case the value
1 (true) is returned in IsHandle, otherwise the value
0 (false) is returned. If a tuple consists of handle
elements only, IsHandle can nevertheless be 0 in case the internal
representation is H_TYPE_MIXED; see tuple_type for details.
Exception: Empty input tuple🔗
If the input tuple is empty, the operator returns 1.
HDevelop In-line Operation🔗
HDevelop provides an in-line operation for tuple_is_handle,
which can be used in an expression in the following syntax:
IsHandle := is_handle(T)
Attention🔗
Even if all tuple elements are of type handle,
tuple_is_handle returns 0 (false) if the internal
representation of the tuple is of type H_TYPE_MIXED. To test if the elements
of the tuple are of type handle, the operator
tuple_is_handle_elem should be used.
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🔗
T (input_control) tuple(-array) → (handle / real / integer / string)
Input tuple.
IsHandle (output_control) number → (integer)
Boolean value indicating if the input tuple is of type
handle.
Result🔗
If the parameters are valid, the operator
tuple_is_handle returns the value 2 (H_MSG_TRUE).
Combinations with other operators🔗
Combinations
Alternatives
tuple_type, tuple_is_number, tuple_is_handle_elem, tuple_is_string, tuple_sem_type
See also
Module🔗
Foundation