read_bar_code_modelT_read_bar_code_modelReadBarCodeModelReadBarCodeModel (Operator)

Name

read_bar_code_modelT_read_bar_code_modelReadBarCodeModelReadBarCodeModel — Read a bar code model from a file and create a new model.

Signature

read_bar_code_model( : : FileName : BarCodeHandle)

Herror T_read_bar_code_model(const Htuple FileName, Htuple* BarCodeHandle)

void ReadBarCodeModel(const HTuple& FileName, HTuple* BarCodeHandle)

void HBarCode::HBarCode(const HString& FileName)

void HBarCode::HBarCode(const char* FileName)

void HBarCode::HBarCode(const wchar_t* FileName)   (Windows only)

void HBarCode::ReadBarCodeModel(const HString& FileName)

void HBarCode::ReadBarCodeModel(const char* FileName)

void HBarCode::ReadBarCodeModel(const wchar_t* FileName)   (Windows only)

static void HOperatorSet.ReadBarCodeModel(HTuple fileName, out HTuple barCodeHandle)

public HBarCode(string fileName)

void HBarCode.ReadBarCodeModel(string fileName)

Description

The operator read_bar_code_modelread_bar_code_modelReadBarCodeModelReadBarCodeModelReadBarCodeModel reads the bar code model from the file FileNameFileNameFileNameFileNamefileName and creates a new model that is an identical copy of the saved model. The parameter BarCodeHandleBarCodeHandleBarCodeHandleBarCodeHandlebarCodeHandle returns the handle of the new model. The model file FileNameFileNameFileNameFileNamefileName must have been created by the operator write_bar_code_modelwrite_bar_code_modelWriteBarCodeModelWriteBarCodeModelWriteBarCodeModel. The default HALCON file extension for bar code model is 'bcm'.

Execution Information

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

FileNameFileNameFileNameFileNamefileName (input_control)  filename.read HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the bar code model file.

Default value: 'bar_code_model.bcm' "bar_code_model.bcm" "bar_code_model.bcm" "bar_code_model.bcm" "bar_code_model.bcm"

File extension: .bcm

BarCodeHandleBarCodeHandleBarCodeHandleBarCodeHandlebarCodeHandle (output_control)  barcode HBarCode, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the bar code model.

Result

The operator read_bar_code_modelread_bar_code_modelReadBarCodeModelReadBarCodeModelReadBarCodeModel returns the value 2 (H_MSG_TRUE) if the named bar code file was found and correctly read. Otherwise, an exception is raised.

Possible Successors

find_bar_codefind_bar_codeFindBarCodeFindBarCodeFindBarCode

Alternatives

create_bar_code_modelcreate_bar_code_modelCreateBarCodeModelCreateBarCodeModelCreateBarCodeModel

See also

write_bar_code_modelwrite_bar_code_modelWriteBarCodeModelWriteBarCodeModelWriteBarCodeModel, clear_bar_code_modelclear_bar_code_modelClearBarCodeModelClearBarCodeModelClearBarCodeModel

Module

Bar Code