C++ API Reference - CBarcodeReader Parameter and Runtime Settings Basic Methods
Method | Description |
---|---|
SetModeArgument |
Set argument value for the specified mode parameter. |
GetModeArgument |
Get argument value for the specified mode parameter. |
GetRuntimeSettings |
Get current runtime settings. |
UpdateRuntimeSettings |
Modify and update the current runtime settings. |
ResetRuntimeSettings |
Reset runtime settings to default. |
SetModeArgument
Set argument value for the specified mode parameter.
int CBarcodeReader::SetModeArgument (const char* pModesName, const int index, const char* pArgumentName, const char* pArgumentValue, char errorMsgBuffer[] = NULL, onst int errorMsgBufferLen = 0)
Parameters
[in] pModesName
The mode parameter name to set argument.
[in] index
The array index of mode parameter to indicate a specific mode.
[in] pArgumentName
The name of the argument to set.
[in] pArgumentValue
The value of the argument to set.
[in,out] errorMsgBuffer
Optional The buffer is allocated by the caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen
Optional The length of the allocated buffer.
Return value
Returns error code. Possible return(s): DBR_OK; DBRERR_SET_MODE_ARGUMENT_ERROR.
You can call GetErrorString
to get detailed error message.
Remark
Check follow link for available modes and arguments:
AccompanyingTextRecognitionModes
BarcodeColourModes
BinarizationModes
ColourClusteringModes
ColourConversionModes
DeformationResistingModes
ImagePreprocessingModes
IntermediateResultSavingMode
LocalizationModes
RegionPredetectionModes
ScaleUpModes
TextAssistedCorrectionMode
TextFilterModes
TextureDetectionModes
Code Snippet
CBarcodeReader* reader = new CBarcodeReader();
reader->InitLicense("t0260NwAAAHV***************");
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
reader->GetRuntimeSettings(pSettings);
pSettings->binarizationModes[0] = BM_LOCAL_BLOCK;
char errorMessage[256];
reader->UpdateRuntimeSettings(pSettings, errorMessage, 256);
reader->SetModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1", errorMessage, 256);
delete pSettings;
delete reader;
GetModeArgument
Get argument value for the specified mode parameter.
int CBarcodeReader::GetModeArgument (const char* pModesName, const int index, const char* pArgumentName, char valueBuffer[], const int valueBufferLen, char errorMsgBuffer[] = NULL, const int errorMsgBufferLen = 0)
Parameters
[in] pModesName
The mode parameter name to get argument.
[in] index
The array index of mode parameter to indicate a specific mode.
[in] pArgumentName
The name of the argument to get.
[in,out] valueBuffer
The buffer is allocated by caller and the recommended length is 480. The argument value would be copied to the buffer.
[in] valueBufferLen
The length of allocated buffer.
[in,out] errorMsgBuffer
Optional The buffer is allocated by the caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen
Optional The length of the allocated buffer.
Return value
Returns error code. Possible return(s): DBR_OK; DBRERR_GET_MODE_ARGUMENT_ERROR.
You can call GetErrorString
to get detailed error message.
Remark
Check follow link for available modes and arguments:
AccompanyingTextRecognitionModes
BarcodeColourModes
BinarizationModes
ColourClusteringModes
ColourConversionModes
DeformationResistingModes
ImagePreprocessingModes
IntermediateResultSavingMode
LocalizationModes
RegionPredetectionModes
ScaleUpModes
TextAssistedCorrectionMode
TextFilterModes
TextureDetectionModes
Code Snippet
CBarcodeReader* reader = new CBarcodeReader();
reader->InitLicense("t0260NwAAAHV***************");
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
reader->GetRuntimeSettings(pSettings);
pSettings->binarizationModes[0] = BM_LOCAL_BLOCK;
char errorMessage[256];
char argumentValue[480];
reader->UpdateRuntimeSettings(pSettings, errorMessage, 256);
reader->SetModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1", errorMessage, 256);
reader->GetModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", argumentValue, 480, errorMessage, 256);
delete pSettings;
delete reader;
GetRuntimeSettings
Get current settings and save them into a PublicRuntimeSettings
struct.
int CBarcodeReader::GetRuntimeSettings (PublicRuntimeSettings* psettings)
Parameters
[in,out] psettings
The struct of template settings.
Return value
Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString
to get detailed error message.
Code Snippet
CBarcodeReader* reader = new CBarcodeReader();
reader->InitLicense("t0260NwAAAHV***************");
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
delete pSettings;
delete reader;
UpdateRuntimeSettings
Update runtime settings with a given PublicRuntimeSettings
struct.
int CBarcodeReader::UpdateRuntimeSettings (PublicRuntimeSettings* pSettings, char errorMsgBuffer[] = NULL, const int errorMsgBufferLen = 0)
Parameters
[in] pSettings
The struct of template settings.
[in,out] errorMsgBuffer
Optional The buffer is allocated by caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen
Optional The length of the allocated buffer.
Return value
Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString
to get detailed error message.
Code Snippet
CBarcodeReader* reader = new CBarcodeReader();
reader->InitLicense("t0260NwAAAHV***************");
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->deblurLevel = 9;
char errorMessage[256];
reader->UpdateRuntimeSettings(pSettings, errorMessage, 256);
delete pSettings;
delete reader;
ResetRuntimeSettings
Reset all parameters to default values.
int CBarcodeReader::ResetRuntimeSettings ()
Return value
Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString
to get detailed error message.
Code Snippet
CBarcodeReader* reader = new CBarcodeReader();
reader->InitLicense("t0260NwAAAHV***************");
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->deblurLevel = 9;
char errorMessage[256];
reader->UpdateRuntimeSettings(pSettings, errorMessage, 256);
reader->ResetRuntimeSettings();
delete pSettings;
delete reader;