Basic Settings Methods
Method | Description |
---|---|
SetModeArgument |
Sets the optional argument for a specified mode in Modes parameters. |
GetModeArgument |
Gets the optional argument for a specified mode in Modes parameters. |
GetRuntimeSettings |
Get current runtime settings. |
UpdateRuntimeSettings |
Update runtime settings with a given struct. |
ResetRuntimeSettings |
Resets all parameters to default values. |
SetModeArgument
Sets the optional argument for a specified mode in Modes parameters.
EnumErrorCode Dynamsoft.DBR.BarcodeReader.SetModeArgument(string modesName, int index, string argumentName, string argumentValue, out string errorMessage)
Parameters
[in] modesName
<string> : The mode parameter name to set argument.
[in] index
<int> : The array index of mode parameter to indicate a specific mode.
[in] argumentName
<string> : The name of the argument to set.
[in] argumentValue
<string> : The value of the argument to set.
[in,out] errorMessage
<string> : The error message.
Return Value
Returns error code.
Code Snippet
string errorMsg;
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
pSettings.BinarizationModes[0] = BM_LOCAL_BLOCK;
string errorMessage;
reader.UpdateRuntimeSettings(pSettings);
EnumErrorCode error = reader.SetModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1", out errorMessage);
//... add further process
reader.Recycle();
}
Remarks
Check follow link for available modes and arguments:
EnumBarcodeColourModes
EnumBinarizationModes
EnumColourClusteringModes
EnumColourConversionModes
EnumDeformationResistingModes
EnumImagePreprocessingModes
EnumIntermediateResultSavingMode
EnumLocalizationModes
EnumRegionPredetectionModes
EnumScaleUpModes
EnumTextFilterModes
EnumTextureDetectionModes
GetModeArgument
Get argument value for the specified mode parameter.
EnumErrorCode Dynamsoft.DBR.BarcodeReader.GetModeArgument(string modesName, int index, string argumentName, out string argumentValue, out string errorMessage)
Parameters
[in] modesName
<string> : The mode parameter name to get argument.
[in] index
<int> : The array index of mode parameter to indicate a specific mode.
[in] argumentName
<string> : The name of the argument to get.
[in,out] argumentValue
<string> : The value of the argument to get.
[in,out] errorMessage
<string> : The error message.
Return Value
Returns error code.
Code Snippet
string errorMsg;
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
pSettings.BinarizationModes[0] = BM_LOCAL_BLOCK;
string errorMessage;
reader.UpdateRuntimeSettings(pSettings);
EnumErrorCode error = reader.SetModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1", errorMessage);
string angumentValue;
EnumErrorCode error = reader.GetModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", out angumentValue, out errorMessage);
//... add further process
reader.Recycle();
}
Remarks
Check follow link for available modes and arguments:
EnumBarcodeColourModes
EnumBinarizationModes
EnumColourClusteringModes
EnumColourConversionModes
EnumDeformationResistingModes
EnumImagePreprocessingModes
EnumIntermediateResultSavingMode
EnumLocalizationModes
EnumRegionPredetectionModes
EnumScaleUpModes
EnumTextFilterModes
EnumTextureDetectionModes
GetRuntimeSettings
Gets current settings and save it into a struct.
PublicRuntimeSettings Dynamsoft.DBR.BarcodeReader.GetRuntimeSettings()
Return Value
The struct of template settings.
Exception
BarcodeReaderException
The exception thrown by Dynamsoft Barcode Reader.
Code Snippet
string errorMsg;
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
//... add further process
reader.Recycle();
}
See Also
PublicRuntimeSettings
UpdateRuntimeSettings
Update runtime settings with a given struct.
void Dynamsoft.DBR.BarcodeReader.UpdateRuntimeSettings(PublicRuntimeSettings settings)
Parameters
[in] settings
<PublicRuntimeSettings> : The struct of template settings.
Exception
BarcodeReaderException
The exception thrown by Dynamsoft Barcode Reader.
Code Snippet
string errorMsg;
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
settings.Timeout = 10000;
settings.MaxAlgorithmThreadCount = 3;
reader.UpdateRuntimeSettings(settings);
//... add further process
reader.Recycle();
}
See Also
PublicRuntimeSettings
ResetRuntimeSettings
Reset all parameters to default values.
void Dynamsoft.DBR.BarcodeReader.ResetRuntimeSettings()
Code Snippet
string errorMsg;
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
settings.Timeout = 10000;
settings.MaxAlgorithmThreadCount = 3;
reader.UpdateRuntimeSettings(settings);
reader.ResetRuntimeSettings();
//... add further process
reader.Recycle();
}