Skip to content

Latest commit

 

History

History
131 lines (88 loc) · 7.28 KB

barcode-complement-modes.md

File metadata and controls

131 lines (88 loc) · 7.28 KB
Raw
layout title description keywords needAutoGenerateSidebar needGenerateH3Content permalink
default-layout
BarcodeComplementModes - Dynamsoft Barcode Reader Parameter Reference
This page shows Dynamsoft Barcode Reader Parameter Reference for BarcodeComplementModes.
BarcodeComplementModes, parameter reference, parameter
true
true
/parameters/reference/barcode-complement-modes.html

BarcodeComplementModes

BarcodeComplementModes determines how to complement the missing parts of a barcode. It consists of one or more modes, each mode is an implement to complement the barcode.

Value Type Value Range Default Value Template Structure Type
int / EnumBarcodeComplementMode N/A BCM_SKIP ImageParameter/FormatSpecification

Candidate Mode List

  • BCM_GENERAL
  • BCM_AUTO

BCM_GENERAL

Complements the barcode using the general algorithm. This mode has the following arguments for further customizing.

BCM_AUTO

Lets the library choose a mode automatically. Not supported yet.

Setting Methods

As PublicRuntimeSettings Member

BarcodeComplementModes can be set dynamically during runtime as a member of FurtherModes, which is a member of PublicRuntimeSettings struct, it is an array with 8 BarcodeComplementMode Enumeration items.

Code Snippet in C++

//...other codes
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->barcodeComplementModes[0] = BCM_GENERAL;
reader->UpdateRuntimeSettings(pSettings);
delete pSettings;
//...other codes

Remarks
GetModeArgument and SetModeArgument need to be called for getting and setting Arguments.

See Also

  • FurtherModes: [C]({{ site.structs }}FurtherModes.html?src=c) | [C++]({{ site.structs }}FurtherModes.html?src=cpp) | [.NET]({{ site.dotnet_api }}struct/FurtherModes.html) | [Java]({{ site.java_api }}class/FurtherModes.html) | [Java-Android]({{ site.android_api }}auxiliary-FurtherModes.html) | [Objective-C & Swift]({{ site.oc_api }}auxiliary-iFurtherModes.html)
  • PublicRuntimeSettings: [JavaScript]({{ site.js_api }}interface/RuntimeSettings.html) | [C]({{ site.structs }}PublicRuntimeSettings.html?src=c) | [C++]({{ site.structs }}PublicRuntimeSettings.html?src=cpp) | [.NET]({{ site.dotnet_api }}struct/PublicRuntimeSettings.html) | [Python]({{ site.python_api }}class/PublicRuntimeSettings.html) | [Java]({{ site.java_api }}class/PublicRuntimeSettings.html) | [Java-Android]({{ site.android_api }}auxiliary-PublicRuntimeSettings.html) | [Objective-C & Swift]({{ site.oc_api }}auxiliary-iPublicRuntimeSettings.html)
  • BarcodeComplementMode: [JavaScript]({{ site.js_enumerations }}EnumBarcodeComplementMode.html) | [C]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=c#barcodecomplementmode) | [C++]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#barcodecomplementmode) | [.NET]({{ site.dotnet_enumerations }}parameter-mode-enums.html#barcodecomplementmode) | [Python]({{ site.python_enumerations }}parameter-mode-enums.html#barcodecomplementmode) | [Java]({{ site.java_enumerations }}parameter-mode-enums.html#barcodecomplementmode) | [Java-Android]({{ site.mobile_enumerations }}barcode-complement-mode.html?lang=android) | [Objective-C & Swift]({{ site.mobile_enumerations }}barcode-complement-mode.html?lang=objc,swift)
  • GetModeArgument: [JavaScript]({{ site.js_api}}BarcodeReader.html#getmodeargument) | [C]({{ site.c_methods }}parameter-and-runtime-settings-basic.html#dbr_getmodeargument) | [C++]({{ site.cpp_methods }}parameter-and-runtime-settings-basic.html#getmodeargument) | [.NET]({{ site.dotnet_api }}BarcodeReader/parameter-and-runtime-settings-basic.html#getmodeargument) | [Python]({{ site.python_api }}BarcodeReader/parameter-and-runtime-settings-basic.html#get_mode_argument) | [Java]({{ site.java_api }}BarcodeReader/parameter-and-runtime-settings-basic.html#getmodeargument) | [Java-Android]({{ site.android_api }}primary-parameter-and-runtime-settings-basic.html#getmodeargument) | [Objective-C & Swift]({{ site.oc_api }}primary-parameter-and-runtime-settings-basic.html#getmodeargument)
  • SetModeArgument: [JavaScript]({{ site.js_api}}BarcodeReader.html#setmodeargument) | [C]({{ site.c_methods }}parameter-and-runtime-settings-basic.html#dbr_setmodeargument) | [C++]({{ site.cpp_methods }}parameter-and-runtime-settings-basic.html#setmodeargument) | [.NET]({{ site.dotnet_api }}BarcodeReader/parameter-and-runtime-settings-basic.html#setmodeargument) | [Python]({{ site.python_api }}BarcodeReader/parameter-and-runtime-settings-basic.html#set_mode_argument) | [Java]({{ site.java_api }}BarcodeReader/parameter-and-runtime-settings-basic.html#setmodeargument) | [Java-Android]({{ site.android_api }}primary-parameter-and-runtime-settings-basic.html#setmodeargument) | [Objective-C & Swift]({{ site.oc_api }}primary-parameter-and-runtime-settings-basic.html#setmodeargument)

As JSON Parameter

BarcodeComplementModes as a JSON parameter is a JSON Object array. Each JSON object is defined as below.

Key Name Key Value Description
Mode Any one in Candidate Mode List as string (Required) Specifies a barcode complement mode.
LibraryFileName A string from value range of LibraryFileName (Optional) Sets the Argument LibraryFileName.
LibraryParameters A string from value range of LibraryParameters (Optional) Sets the Argument LibraryParameters.

JSON Parameter Example

{
    "BarcodeComplementModes": [
        {
            "Mode": "BCM_GENERAL" 
        }
    ]
}

Candidate Argument List

LibraryFileName

Sets the file name of the library to load dynamically.

Value Type Value Range Default Value Valid For
string A string value representing file name. "" All modes

Remarks
The library must be in the same place with Dynamsoft Barcode Reader Library.

LibraryParameters

Sets the parameters passed to the library to load dynamically.

Value Type Value Range Default Value Valid For
string A string value representing parameters. "" All modes

Related Articles

  • [Use RuntimeSettings or Templates for Configuring Parameters]({{ site.features }}use-runtimesettings-or-templates.html)
  • [How to decode incomplete barcodes]({{ site.scenario_settings }}how-to-set-barcode-complememt-modes.html)