Skip to content

tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handleT_tuple_is_valid_handle🔗

Short description🔗

tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handleT_tuple_is_valid_handle — Check if a handle is valid.

Signature🔗

tuple_is_valid_handle( tuple Handle, out integer IsValid )void TupleIsValidHandle( const HTuple& Handle, HTuple* IsValid )static void HOperatorSet.TupleIsValidHandle( HTuple handle, out HTuple isValid )def tuple_is_valid_handle( handle: MaybeSequence[HHandle] ) -> Sequence[int]

def tuple_is_valid_handle_s( handle: MaybeSequence[HHandle] ) -> intHerror T_tuple_is_valid_handle( const Htuple Handle, Htuple* IsValid )

HTuple HTuple::TupleIsValidHandle( ) const

HTuple HHandle::TupleIsValidHandle( ) const

HTuple HTuple.TupleIsValidHandle( )

HTuple HHandle.TupleIsValidHandle( )

Description🔗

tuple_is_valid_handleTupleIsValidHandle returns 11 in IsValidisValidis_valid if Handlehandlehandle is a valid handle that has not been cleared, and 00 otherwise.

If multiple handles are passed in Handlehandlehandle, a validity value will be returned for each of them in IsValidisValidis_valid.

Exception: Empty input tuple🔗

If the input tuple is empty, the operator returns an empty tuple.

HDevelop In-line Operation🔗

HDevelop provides an in-line operation for tuple_is_valid_handleTupleIsValidHandle, which can be used in an expression in the following syntax:

IsValid := is_valid_handle(Handle)

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🔗

Handlehandlehandle (input_control) tuple(-array) → (handle)HTuple (HHandle)HTuple (HHandle)MaybeSequence[HHandle]Htuple (handle)

The handle to check for validity.

IsValidisValidis_valid (output_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

The validity of the handle, 11 or 00.

Result🔗

If the parameters are valid, the operator tuple_is_valid_handleTupleIsValidHandle returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.

Module🔗

Foundation