close_measureT_close_measureCloseMeasureCloseMeasureclose_measure (Operator)

Name

close_measureT_close_measureCloseMeasureCloseMeasureclose_measure — Delete a measure object.

Signature

close_measure( : : MeasureHandle : )

Description

close_measureclose_measureCloseMeasureCloseMeasureCloseMeasureclose_measure deletes the measure object given by MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_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:

MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle

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

Parameters

MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle (input_control, state is modified) measure → (handle)

Measure object handle.

Result

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