Operator Reference

clear_data_code_2d_modelT_clear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModelclear_data_code_2d_model (Operator)

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

Signature

clear_data_code_2d_model( : : DataCodeHandle : )

Herror T_clear_data_code_2d_model(const Htuple DataCodeHandle)

void ClearDataCode2dModel(const HTuple& DataCodeHandle)

void HDataCode2D::ClearDataCode2dModel() const

static void HOperatorSet.ClearDataCode2dModel(HTuple dataCodeHandle)

void HDataCode2D.ClearDataCode2dModel()

def clear_data_code_2d_model(data_code_handle: HHandle) -> None

Description

The operator clear_data_code_2d_modelclear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModelclear_data_code_2d_model deletes a 2D data code model that was created by create_data_code_2d_modelcreate_data_code_2d_modelCreateDataCode2dModelCreateDataCode2dModelcreate_data_code_2d_model or read_data_code_2d_modelread_data_code_2d_modelReadDataCode2dModelReadDataCode2dModelread_data_code_2d_model. All memory used by the model is freed. The handle of the model is passed in DataCodeHandleDataCodeHandleDataCodeHandledataCodeHandledata_code_handle. 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:

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

Parameters

DataCodeHandleDataCodeHandleDataCodeHandledataCodeHandledata_code_handle (input_control, state is modified)  datacode_2d HDataCode2D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 2D data code model.

Result

The operator clear_data_code_2d_modelclear_data_code_2d_modelClearDataCode2dModelClearDataCode2dModelclear_data_code_2d_model 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.

See also

create_data_code_2d_modelcreate_data_code_2d_modelCreateDataCode2dModelCreateDataCode2dModelcreate_data_code_2d_model, read_data_code_2d_modelread_data_code_2d_modelReadDataCode2dModelReadDataCode2dModelread_data_code_2d_model

Module

Data Code