.Net API Reference - BarcodeReader Parameter and Runtime Settings Basic 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.Barcode.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.
Remark
Check follow link for available modes and arguments:
EnumAccompanyingTextRecognitionModesEnumBarcodeColourModesEnumBinarizationModesEnumColourClusteringModesEnumColourConversionModesEnumDeformationResistingModesEnumImagePreprocessingModesEnumIntermediateResultSavingModeEnumLocalizationModesEnumRegionPredetectionModesEnumScaleUpModesEnumTextAssistedCorrectionModeEnumTextFilterModesEnumTextureDetectionModes
Code Snippet
BarcodeReader reader = new BarcodeReader();
reader.ProductKeys = "t0260NwAAAHV***************";
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);
reader.Dispose();
GetModeArgument
Get argument value for the specified mode parameter.
EnumErrorCode Dynamsoft.Barcode.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.
Remark
Check follow link for available modes and arguments:
EnumAccompanyingTextRecognitionModesEnumBarcodeColourModesEnumBinarizationModesEnumColourClusteringModesEnumColourConversionModesEnumDeformationResistingModesEnumImagePreprocessingModesEnumIntermediateResultSavingModeEnumLocalizationModesEnumRegionPredetectionModesEnumScaleUpModesEnumTextAssistedCorrectionModeEnumTextFilterModesEnumTextureDetectionModes
Code Snippet
BarcodeReader reader = new BarcodeReader();
reader.ProductKeys = "t0260NwAAAHV***************";
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);
reader.Dispose();
GetRuntimeSettings
Gets current settings and save it into a struct.
PublicRuntimeSettings Dynamsoft.Barcode.BarcodeReader.GetRuntimeSettings()
Return value
The struct of template settings.
Exceptions
BarcodeReaderException The exception thrown by Dynamsoft Barcode Reader.
Code Snippet
BarcodeReader reader = new BarcodeReader();
reader.ProductKeys = "t0260NwAAAHV***************";
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
reader.Dispose();
See Also
UpdateRuntimeSettings
Update runtime settings with a given struct.
void Dynamsoft.Barcode.BarcodeReader.UpdateRuntimeSettings(PublicRuntimeSettings settings)
Parameters
[in] settings <PublicRuntimeSettings> : The struct of template settings.
Exceptions
BarcodeReaderException The exception thrown by Dynamsoft Barcode Reader.
Code Snippet
BarcodeReader reader = new BarcodeReader();
reader.ProductKeys = "t0260NwAAAHV***************";
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
settings.Timeout = 10000;
settings.MaxAlgorithmThreadCount = 3;
reader.UpdateRuntimeSettings(settings);
reader.Dispose();
See Also
ResetRuntimeSettings
Reset all parameters to default values.
void Dynamsoft.Barcode.BarcodeReader.ResetRuntimeSettings()
Code Snippet
BarcodeReader reader = new BarcodeReader();
reader.ProductKeys = "t0260NwAAAHV***************";
PublicRuntimeSettings settings = reader.GetRuntimeSettings();
settings.Timeout = 10000;
settings.MaxAlgorithmThreadCount = 3;
reader.UpdateRuntimeSettings(settings);
reader.ResetRuntimeSettings();
reader.Dispose();
Yes
No