tuple_is_handleT_tuple_is_handleTupleIsHandleTupleIsHandle (Operator)
Name
tuple_is_handleT_tuple_is_handleTupleIsHandleTupleIsHandle — Test if the internal representation of a tuple is of type handle.
Signature
Herror T_tuple_is_handle(const Htuple T, Htuple* IsHandle)
Description
tuple_is_handletuple_is_handleTupleIsHandleTupleIsHandleTupleIsHandle tests if the internal representation of the
input tuple TTTTt is of type handle. In that case
the value 1 (true) is returned in IsHandleIsHandleIsHandleIsHandleisHandle, otherwise the value
0 (false) is returned. If a tuple consists of handle elements only,
IsHandleIsHandleIsHandleIsHandleisHandle can nevertheless be 0 in case the internal representation
is H_TYPE_MIXED; see tuple_typetuple_typeTupleTypeTupleTypeTupleType 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_handletuple_is_handleTupleIsHandleTupleIsHandleTupleIsHandle,
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_handletuple_is_handleTupleIsHandleTupleIsHandleTupleIsHandle 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_elemtuple_is_handle_elemTupleIsHandleElemTupleIsHandleElemTupleIsHandleElem
should be used.
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
TTTTt (input_control) tuple(-array) → HTupleHTupleHtuple (handle / real / integer / string) (HHandle / double / int / long / string) (HHandle / double / Hlong / HString) (handle / double / Hlong / char*)
Input tuple.
IsHandleIsHandleIsHandleIsHandleisHandle (output_control) number → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Boolean value indicating if the input tuple is of type
handle.
Result
If the parameters are valid, the operator
tuple_is_handletuple_is_handleTupleIsHandleTupleIsHandleTupleIsHandle returns the value 2 (H_MSG_TRUE).
Alternatives
tuple_typetuple_typeTupleTypeTupleTypeTupleType,
tuple_is_numbertuple_is_numberTupleIsNumberTupleIsNumberTupleIsNumber,
tuple_is_handle_elemtuple_is_handle_elemTupleIsHandleElemTupleIsHandleElemTupleIsHandleElem,
tuple_is_stringtuple_is_stringTupleIsStringTupleIsStringTupleIsString,
tuple_sem_typetuple_sem_typeTupleSemTypeTupleSemTypeTupleSemType
See also
tuple_is_inttuple_is_intTupleIsIntTupleIsIntTupleIsInt,
tuple_is_realtuple_is_realTupleIsRealTupleIsRealTupleIsReal,
tuple_is_stringtuple_is_stringTupleIsStringTupleIsStringTupleIsString
Module
Foundation