clear_data_code_2d_modelT_clear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModel (Operator)

Name

clear_data_code_2d_modelT_clear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModel — Delete a 2D data code model and free the allocated memory.

Signature

clear_data_code_2d_model( : : DataCodeHandle : )

Description

The operator clear_data_code_2d_modelclear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModelClearDataCode2dModel deletes a 2D data code model that was created by create_data_code_2d_modelcreate_data_code_2d_modelCreateDataCode2dModelCreateDataCode2dModelCreateDataCode2dModel or read_data_code_2d_modelread_data_code_2d_modelReadDataCode2dModelReadDataCode2dModelReadDataCode2dModel. All memory used by the model is freed. The handle of the model is passed in DataCodeHandleDataCodeHandleDataCodeHandleDataCodeHandledataCodeHandle. After the operator call it is invalid.

For an explanation of the concept of the 2D data code reader see the introduction of chapter Identification / Data Code.

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:

DataCodeHandleDataCodeHandleDataCodeHandleDataCodeHandledataCodeHandle

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

Parameters

DataCodeHandleDataCodeHandleDataCodeHandleDataCodeHandledataCodeHandle (input_control, state is modified) datacode_2d → (handle)

Handle of the 2D data code model.

Result

The operator clear_data_code_2d_modelclear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModelClearDataCode2dModel returns the value 2 (H_MSG_TRUE) if a valid handle was passed and the referred 2D data code model can be freed correctly. Otherwise, an exception is raised.

Module

Data Code

Operators