tuple_is_valid_handleT_tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandle (Operator)
Name
tuple_is_valid_handleT_tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandle — Check if a handle is valid.
Signature
Herror T_tuple_is_valid_handle(const Htuple Handle, Htuple* IsValid)
Description
tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandleTupleIsValidHandle returns 1 in IsValidIsValidIsValidIsValidisValid if
HandleHandleHandleHandlehandle is a valid handle that has not ben cleared, and 0
otherwise.
If multiple handles are passed in HandleHandleHandleHandlehandle, a
validity value will be returned for each of them in IsValidIsValidIsValidIsValidisValid.
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
HandleHandleHandleHandlehandle (input_control) tuple(-array) → HTupleHTupleHtuple (handle) (HHandle) (HHandle) (handle)
The handle to check for validity.
IsValidIsValidIsValidIsValidisValid (output_control) integer(-array) → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
The validity of the handle, 1 or 0.
Result
If the parameters are valid, the operator tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandleTupleIsValidHandle
returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.
Module
Foundation