Operator Reference

close_measureT_close_measureCloseMeasureCloseMeasureclose_measure (Operator)

close_measureT_close_measureCloseMeasureCloseMeasureclose_measure — Delete a measure object.

Signature

close_measure( : : MeasureHandle : )

Herror T_close_measure(const Htuple MeasureHandle)

void CloseMeasure(const HTuple& MeasureHandle)

void HMeasure::CloseMeasure() const

static void HOperatorSet.CloseMeasure(HTuple measureHandle)

void HMeasure.CloseMeasure()

def close_measure(measure_handle: HHandle) -> None

Description

close_measureclose_measureCloseMeasureCloseMeasureclose_measure deletes the measure object given by MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle. The memory used for the measure object is freed.

For an explanation of the concept of 1D measuring see the introduction of chapter 1D Measuring.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle (input_control, state is modified)  measure HMeasure, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Measure object handle.

Result

If the parameter values are correct the operator close_measureclose_measureCloseMeasureCloseMeasureclose_measure returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2, gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcgen_measure_arc, measure_posmeasure_posMeasurePosMeasurePosmeasure_pos, measure_pairsmeasure_pairsMeasurePairsMeasurePairsmeasure_pairs

Alternatives

clear_handleclear_handleClearHandleClearHandleclear_handle

See also

clear_handleclear_handleClearHandleClearHandleclear_handle

Module

1D Metrology