tuple_is_valid_handleT_tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle (Operator)
Name
tuple_is_valid_handleT_tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle — Check if a handle is valid.
Signature
Herror T_tuple_is_valid_handle(const Htuple Handle, Htuple* IsValid)
def tuple_is_valid_handle(handle: MaybeSequence[HHandle]) -> Sequence[int]
def tuple_is_valid_handle_s(handle: MaybeSequence[HHandle]) -> int
Description
tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle returns 1 in IsValidIsValidIsValidIsValidisValidis_valid if
HandleHandleHandleHandlehandlehandle is a valid handle that has not been cleared, and 0
otherwise.
If multiple handles are passed in HandleHandleHandleHandlehandlehandle, a
validity value will be returned for each of them in IsValidIsValidIsValidIsValidisValidis_valid.
Exception: Empty input tuple
If the input tuple is empty, the operator returns an empty tuple.
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
HandleHandleHandleHandlehandlehandle (input_control) tuple(-array) → HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (HHandle) (HHandle) (handle)
The handle to check for validity.
IsValidIsValidIsValidIsValidisValidis_valid (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (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_handleTupleIsValidHandleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle
returns the value 2 (
H_MSG_TRUE)
. Otherwise, an exception is raised.
Module
Foundation