clear_variation_modelclear_variation_modelClearVariationModelClearVariationModel (Operator)

Name

clear_variation_modelclear_variation_modelClearVariationModelClearVariationModel — Free the memory of a variation model.

Signature

clear_variation_model( : : ModelID : )

Description

clear_variation_modelclear_variation_modelClearVariationModelClearVariationModelClearVariationModel frees the memory of a variation model that was created by create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModel. After calling create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModel, the model can no longer be used. The handle ModelIDModelIDModelIDModelIDmodelID becomes invalid.

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:

ModelIDModelIDModelIDModelIDmodelID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified) variation_model → (integer)

ID of the variation model.

Result

clear_variation_modelclear_variation_modelClearVariationModelClearVariationModelClearVariationModel returns 2 (H_MSG_TRUE) if all parameters are correct.

Possible Predecessors

create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModel

Module

Matching

Operators