Parameter and Runtime Settings Basic Functions
Function | Description |
---|---|
DBR_SetModeArgument |
Set argument value for the specified mode parameter. |
DBR_GetModeArgument |
Get argument value for the specified mode parameter. |
DBR_GetRuntimeSettings |
Get current runtime settings. |
DBR_UpdateRuntimeSettings |
Modify and update the current runtime settings. |
DBR_ResetRuntimeSettings |
Reset runtime settings to default. |
DBR_SetModeArgument
Set argument value for the specified mode parameter.
DBR_API int DBR_SetModeArgument (void* barcodeReader, const char* pModesName, const int index, const char* pArgumentName, const char* pArgumentValue, char errorMsgBuffer[], const int errorMsgBufferLen)
Parameters
[in] barcodeReader
Handle of the barcode reader instance.
[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 The buffer is allocated by the caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen
The length of the allocated buffer.
Return Value
Returns error code. Possible return(s): DBR_OK; DBRERR_SET_MODE_ARGUMENT_ERROR.
You can call DBR_GetErrorString
to get detailed error message.
Code Snippet
char errorBuf[512];
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
PublicRuntimeSettings settings;
DBR_GetRuntimeSettings(barcodeReader, &settings);
settings.binarizationModes[0] = BM_LOCAL_BLOCK;
char errorMessage[256];
DBR_UpdateRuntimeSettings(barcodeReader, &settings, errorMessage, 256);
DBR_SetModeArgument(barcodeReader, "BinarizationModes", 0, "EnableFillBinaryVacancy", "1", errorMessage, 256);
//... more process here
DBR_RecycleInstance(barcodeReader);
}
Remarks
Check follow link for available modes and arguments:
BarcodeColourModes
BinarizationModes
ColourClusteringModes
ColourConversionModes
DeformationResistingModes
ImagePreprocessingModes
IntermediateResultSavingMode
LocalizationModes
RegionPredetectionModes
ScaleUpModes
TextFilterModes
TextureDetectionModes
DBR_GetModeArgument
Get argument value for the specified mode parameter.
DBR_API int DBR_GetModeArgument (void* barcodeReader, const char* pModesName, const int index, const char* pArgumentName, char valueBuffer[], const int valueBufferLen, char errorMsgBuffer[], const int errorMsgBufferLen)
Parameters
[in] barcodeReader
Handle of the barcode reader instance.
[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
The buffer is allocated by the caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen
The length of the allocated buffer.
Return Value
Returns error code. Possible return(s): DBR_OK; DBRERR_GET_MODE_ARGUMENT_ERROR.
You can call DBR_GetErrorString
to get detailed error message.
Code Snippet
char errorBuf[512];
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
PublicRuntimeSettings settings;
DBR_GetRuntimeSettings(barcodeReader, &settings);
settings.binarizationModes[0] = BM_LOCAL_BLOCK;
char errorMessage[256];
char argumentValue[480];
DBR_UpdateRuntimeSettings(barcodeReader, &settings, errorMessage, 256);
DBR_SetModeArgument(barcodeReader, "BinarizationModes", 0, "EnableFillBinaryVacancy", "1", errorMessage, 256);
DBR_GetModeArgument(barcodeReader, "BinarizationModes", 0, "EnableFillBinaryVacancy", argumentValue, 480, errorMessage, 256);
//... more process here
DBR_RecycleInstance(barcodeReader);
}
Remarks
Check follow link for available modes and arguments:
BarcodeColourModes
BinarizationModes
ColourClusteringModes
ColourConversionModes
DeformationResistingModes
ImagePreprocessingModes
IntermediateResultSavingMode
LocalizationModes
RegionPredetectionModes
ScaleUpModes
TextFilterModes
TextureDetectionModes
DBR_GetRuntimeSettings
Get current settings and save them into a PublicRuntimeSettings
struct.
DBR_API int DBR_GetRuntimeSettings (void* barcodeReader, PublicRuntimeSettings* pSettings)
Parameters
[in] barcodeReader
Handle of the barcode reader instance.
[in,out] pSettings
The struct of template settings.
Return Value
Returns error code (returns 0 if the function operates successfully).
You can call DBR_GetErrorString
to get detailed error message.
Code Snippet
char errorBuf[512];
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
PublicRuntimeSettings settings;
int errorCode = DBR_GetRuntimeSettings(barcodeReader, &settings);
//... more process here
DBR_RecycleInstance(barcodeReader);
}
DBR_UpdateRuntimeSettings
Update runtime settings with a given PublicRuntimeSettings
struct.
DBR_API int DBR_UpdateRuntimeSettings (void* barcodeReader, PublicRuntimeSettings* pSettings, char errorMsgBuffer[], const int errorMsgBufferLen)
Parameters
[in] barcodeReader
Handle of the barcode reader instance.
[in] pSettings
The struct of template settings.
[in,out] errorMsgBuffer
The buffer is allocated by caller and the recommended length is 256.The error message will be copied to the buffer.
[in] errorMsgBufferLen
The length of the allocated buffer.
Return Value
Returns error code (returns 0 if the function operates successfully).
You can call DBR_GetErrorString
to get detailed error message.
Code Snippet
char errorBuf[512];
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
PublicRuntimeSettings settings;
int errorCode = DBR_GetRuntimeSettings(barcodeReader, &settings);
settings.deblurLevel = 9;
char errorMessage[256];
DBR_UpdateRuntimeSettings(barcodeReader, &settings, errorMessage, 256);
//... more process here
DBR_RecycleInstance(barcodeReader);
}
DBR_ResetRuntimeSettings
Reset all parameters to default values.
DBR_API int DBR_ResetRuntimeSettings (void* barcodeReader)
Parameters
[in] barcodeReader
Handle of the barcode reader instance.
Return Value
Returns error code (returns 0 if the function operates successfully).
You can call DBR_GetErrorString
to get detailed error message.
Code Snippet
char errorBuf[512];
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
PublicRuntimeSettings settings;
int errorCode = DBR_GetRuntimeSettings(barcodeReader, &settings);
settings.deblurLevel = 9;
DBR_UpdateRuntimeSettings(barcodeReader, &settings);
DBR_ResetRuntimeSettings(barcodeReader);
//... more process here
DBR_RecycleInstance(barcodeReader);
}