### Install New NuGet Package

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/migrate-from-v9/index.md

Run this command to install the updated Dynamsoft.DotNet.BarcodeReader.Bundle NuGet package, which replaces the older 'Dynamsoft.DotNet.Barcode' package.

```powershell
NuGet\Install-Package Dynamsoft.DotNet.BarcodeReader.Bundle
```

--------------------------------

### Output Example for Single Image Processing

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

This is an example of the console output you can expect after processing a single image with the barcode reader.

```text
Decoded 2 barcodes
Result 1
Barcode Format: XXX
Barcode Text: XXX
Result 2
Barcode Format: XXX
Barcode Text: XXX
```

--------------------------------

### Start Image Capturing Process

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

Initiate the barcode scanning process for all images in the configured input source. Includes basic error handling for the start capturing command.

```python
errorCode, errorMsg = cvr_instance.start_capturing("", True)
if errorCode != EnumErrorCode.EC_OK:
    print("error:", errorMsg)
```

--------------------------------

### Start Barcode Capturing in C++

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/user-guide.md

Initiate the barcode capturing process for images in a specified folder. This method starts the asynchronous processing of images.

```cpp
int errorCode = cvRouter->StartCapturing(CPresetTemplate::PT_READ_BARCODES, true, errorMsg, 512);

```

--------------------------------

### Video Streaming Decoding Example

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/upgrade-instruction.md

Implement `CProactiveImageSourceAdapter` and `CCapturedResultReceiver` to handle video frame capture and barcode result processing. This example demonstrates the basic structure for integrating video decoding with `CCaptureVisionRouter`.

```cpp
class MyVideoSource : public CProactiveImageSourceAdapter 
{
    // You should implement the `HasNextImageToFetch` method to indicate if there is a next frame
    bool HasNextImageToFetch() const override 
    {
        return true;
    }

    // You should implement the `FetchImage` method to get the next frame
    CImageData* FetchImage() override
    {
        // Add code to get the video frame from camera or video file
    }
};

class MyBarcodeResultReceiver: public CCapturedResultReceiver
{
public:
    virtual void OnDecodedBarcodesReceived(DecodedBarcodesResult * result) {
        // Add code to process the result
    }
};

int main()
{
    CCaptureVisionRouter *cvRouter = new CCaptureVisionRouter;

    // Create your video source and bind it to the router
    MyVideoSource *source = new MyVideoSource;
    cvRouter->SetInput(source);

    // Create a CCapturedResultReceiver instance 
    MyBarcodeResultReceiver *barcodesReceiver = new MyCapturedResultReceiver;
    cvRouter->AddResultReceiver(barcodesReceiver);

    // Start capturing
    errorCode = cvRouter->StartCapturing(CPresetTemplate::PT_READ_BARCODES, true, errorMsg, 512);

    delete barcodesReceiver;
    delete source;
    delete cvRouter;
}
```

--------------------------------

### GetFormat

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcode-element.md

Gets the format of the barcode.

```APIDOC
## GetFormat

### Description
Gets the format of the barcode.

### Method
```csharp
EnumBarcodeFormat GetFormat()
```

### Return Value
Returns the format of the barcode.

### See Also
[EnumBarcodeFormat]({{ site.dbr_dotnet_api }}enum-barcode-format.html)
```

--------------------------------

### startPatternRange

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/oned-code-details.md

The position of the start pattern relative to the barcode location.

```APIDOC
## startPatternRange

### Description
The position of the start pattern relative to the barcode location.

### Type
float[]

### Remarks
The property represents a float array of length 2:
- Index 0: X coordinate of the start position in percentage value.
- Index 1: X coordinate of the end position in percentage value.

### Definition
```csharp
float[] startPatternRange
```
```

--------------------------------

### getPossibleFormats Method

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/candidate-barcode-zone.md

Gets the possible formats of the candidate barcode.

```APIDOC
## getPossibleFormats()

### Description
Gets the possible formats of the candidate barcode.

### Method
```java
public long getPossibleFormats()
```

### Return Value
Returns the possible formats of the candidate barcode.
```

--------------------------------

### GetPossibleFormats

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/candidate-barcode-zone.md

Gets the possible formats of the candidate barcode.

```APIDOC
## GetPossibleFormats

### Description
Gets the possible formats of the candidate barcode.

### Method
```csharp
ulong GetPossibleFormats()
```

### Return value
Returns the possible formats of the candidate barcode.

### See Also
[EnumBarcodeFormat]({{ site.dbr_dotnet_api }}enum-barcode-format.html)
```

--------------------------------

### Get ECI Segments

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/decoded-barcode-element.md

Gets all the ECI segments in the barcode.

```APIDOC
## get_eci_segments

### Description
Gets all the ECI segments in the barcode.

### Method
```python
def get_eci_segments(self) -> List[ECISegment]:
```

### Return Value
Returns a list of [`ECISegment`]({{ site.dbr_python_api }}eci-segment.html) objects. Returns an empty list if no ECI information is present.

### See Also
[ECISegment]({{ site.dbr_python_api }}eci-segment.html)

### Remarks
Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.
```

--------------------------------

### Maven Project Generation Command

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Use this Maven command to generate a new quickstart project. Ensure you are in the desired project directory before running.

```bash
mvn archetype:generate -DgroupId=com.dynamsoft -DartifactId=dbr-hello-world -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
```

--------------------------------

### Get ECI Segment

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Gets the ECI segment at the specified index.

```cpp
virtual int GetECISegment(int index) const = 0;
```

--------------------------------

### Initialize License Key

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Initialize the license for using the SDK. A network connection is required for the trial license. Alternatively, request a 30-day free offline trial license.

```java
public class ReadAnImage {
    public static void main(String[] args) {
        try {
            LicenseError licenseError = LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
            if (licenseError.getErrorCode() != EnumErrorCode.EC_OK) {
                System.out.println("License initialization failed: ErrorCode: " + licenseError.getErrorCode() + ", ErrorString: " + licenseError.getErrorString());
                return;
            }
        } catch (LicenseException e) {
            System.out.println("License initialization failed: ErrorCode: " + e.getErrorCode() + ", ErrorString: " + e.getErrorString());
            return;
        }
        // codes from following steps
    }
}
```

--------------------------------

### Get Task Name

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Inherited from CCapturedResultItem, this method gets the name of the task associated with the captured result.

```cpp
virtual const char* GetTaskName() const;
```

--------------------------------

### Initialize CandidateBarcodeZone

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/candidate-barcode-zone.md

Initializes a new instance of the CandidateBarcodeZone class. This is the default constructor.

```java
public CandidateBarcodeZone()
```

--------------------------------

### Get Barcode Format String

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Retrieves the format of the decoded barcode as a string.

```cpp
virtual const char* GetFormatString() const = 0;
```

--------------------------------

### Get Referenced Item

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Inherited from CCapturedResultItem, this method gets a pointer to the referenced item in the captured result.

```cpp
virtual CCapturedResultItem* GetReferenceItem() const;
```

--------------------------------

### Compile and Run Project with Maven

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Compile and execute the Java project using Maven. This command specifies the main class to run.

```bash
mvn compile exec:java "-Dexec.mainClass=ReadAnImage"
```

--------------------------------

### QRCodeDetails Constructor with Parameters

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/qr-code-details.md

Initializes a new instance of the QRCodeDetails class with specified QR Code structural values.

```java
public QRCodeDetails(int rows, int columns, int errorCorrectionLevel, int version, int model, int mode, int page, int totalPage, int parityData)
```

--------------------------------

### Get Extended Barcode Result by Index

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/decoded-barcode-element.md

Gets the extended barcode result at the specified index for the decoded barcode.

```APIDOC
## get_extended_barcode_result

### Description
Gets the extended barcode result at the specified index for the decoded barcode.

### Method
```python
def get_extended_barcode_result(self, index: int) -> "ExtendedBarcodeResult":
```

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the extended barcode result to retrieve.

### Return value
Returns an `ExtendedBarcodeResult` object at the specified index for the decoded barcode.

### See Also
[ExtendedBarcodeResult]({{ site.dbr_python_api }}extended-barcode-result.html)
```

--------------------------------

### Create DirectoryFetcher for Image Input

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/user-guide.md

Initialize a DirectoryFetcher to specify the directory containing images for multi-image processing. Update the placeholder with the actual directory path.

```csharp
DirectoryFetcher fetcher = new DirectoryFetcher();
fetcher.SetDirectory("[THE DIRECTORY THAT HOLDS THE IMAGES]");
```

--------------------------------

### Get Target ROI Definition Name

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Inherited from CCapturedResultItem, this method gets the name of the target ROI definition.

```cpp
virtual const char* GetTargetROIDefName() const;
```

--------------------------------

### Get Captured Result Item Type

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Inherited from CCapturedResultItem, this method gets the type of the captured result item.

```cpp
virtual EnumResultType GetType() const;
```

--------------------------------

### CandidateBarcodeZone Initialization

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/candidate-barcode-zone.md

Initializes a new instance of the CandidateBarcodeZone class with optional location and possible formats.

```APIDOC
## __init__

### Description
Initializes a new instance of the `CandidateBarcodeZone` class.

### Parameters
- **location** (Quadrilateral, optional) - The location of the candidate barcode.
- **possible_formats** (int, optional) - The possible formats of the candidate barcode.
```

--------------------------------

### Copy Linux Resources

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/user-guide.md

Copy template and model files to the specified directory for the Linux build to function correctly.

```bash
cp -r ../Dist/Templates ../Dist/Lib/Linux/x64/
cp -r ../Dist/Models ../Dist/Lib/Linux/x64/
```

--------------------------------

### Initialize CandidateBarcodeZone

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/candidate-barcode-zone.md

Initializes a new instance of the CandidateBarcodeZone class. You can optionally provide the initial location and possible formats.

```python
def __init__(self, location: Quadrilateral=None, possibleFormats: int=None):
```

--------------------------------

### Initialize Dynamsoft Barcode Reader License

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/user-guide.md

Initialize the SDK with a license key before using its features. A network connection is required for the provided public trial license. Consider obtaining a 30-day offline trial license for development.

```csharp
int errorCode = 1;
string errorMsg;
errorCode = LicenseManager.InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", out errorMsg);
if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_LICENSE_CACHE_USED)
    Console.WriteLine("License initialization error: " + errorMsg);
```

--------------------------------

### startPatternRange Attribute

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/oned-code-details.md

Defines the position of the start pattern relative to the barcode. The array contains the X coordinates (percentage) of the start and end positions.

```cpp
float startPatternRange[2]
```

--------------------------------

### CandidateBarcodeZone Constructor

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/candidate-barcode-zone.md

Initializes a new instance of the CandidateBarcodeZone class.

```APIDOC
## CandidateBarcodeZone()

### Description
Initializes a new instance of the `CandidateBarcodeZone` class.

### Method
```java
public CandidateBarcodeZone()
```
```

--------------------------------

### Get Barcode Text

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Retrieves the decoded barcode text in UTF-8 encoding. If automatic encoding detection is inaccurate, use GetBytes to get raw data.

```cpp
virtual const char* GetText() const = 0;
```

--------------------------------

### Add Directory Fetcher for Multiple Images

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/user-guide.md

Include the DynamsoftUtility module and link the appropriate library for Windows builds. Set up a CDirectoryFetcher to process images from a directory.

```cpp
// Add the following lines
using namespace dynamsoft::utility;
#ifdef _WIN64
#pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x64/DynamsoftUtilityx64.lib")
#else
#pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x86/DynamsoftUtilityx86.lib")
#endif
```

```cpp
CDirectoryFetcher *fetcher = new CDirectoryFetcher;
fetcher->SetDirectory("[THE DIRECTORY THAT HOLDS THE IMAGES]");
cvRouter->SetInput(fetcher);
```

--------------------------------

### ECISegment Start Index

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/eci-segment.md

Indicates the start index of this ECI segment within the decoded barcode bytes. This property helps locate the segment's position.

```python
start_index: int

```

--------------------------------

### Set Directory for Image Fetching

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

Initialize DirectoryFetcher and specify the directory containing images for batch processing. Replace the placeholder with the actual directory path.

```python
fetcher = DirectoryFetcher()
fetcher.set_directory("[THE DIRECTORY THAT HOLDS THE IMAGES]")
```

--------------------------------

### OneDCodeDetails startPatternRange Attribute

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/oned-code-details.md

Specifies the position of the start pattern relative to the barcode location. The array contains X coordinates for the start and end of the pattern as percentage values.

```java
public float[] startPatternRange
```

--------------------------------

### Initialize License Key

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

Initialize the Dynamsoft Barcode Reader SDK with a license key. Check the error code to ensure successful initialization. A network connection is required for the provided free trial license.

```python
errorCode, errorMsg = LicenseManager.init_license("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9")
if errorCode != EnumErrorCode.EC_OK and errorCode != EnumErrorCode.EC_LICENSE_CACHE_USED:
    print("License initialization failed: ErrorCode:", errorCode, ", ErrorString:", errorMsg)
else:
    # codes from following steps

```

--------------------------------

### Create DirectoryFetcher for Image Source

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Initialize a DirectoryFetcher to retrieve images from a specified local directory for multi-image processing. Replace the placeholder with the actual directory path.

```java
DirectoryFetcher fetcher = new DirectoryFetcher();
fetcher.setDirectory("[THE DIRECTORY THAT HOLDS THE IMAGES]");
```

--------------------------------

### Register Listeners and Input with CaptureVisionRouter

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

Configure the CaptureVisionRouter instance by setting the input source, adding the result receiver, and attaching the image source state listener.

```python
cvr_instance.set_input(fetcher)
receiver = MyCapturedResultReceiver()
cvr_instance.add_result_receiver(receiver)
listener = MyImageSourceStateListener(cvr_instance)
cvr_instance.add_image_source_state_listener(listener)
```

--------------------------------

### getPossibleFormats

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/localized-barcode-element.md

Gets the format of the barcode.

```APIDOC
## getPossibleFormats()

### Description
Gets the format of the barcode.

### Method
```java
public long getPossibleFormats()
```

### Return value
Returns the format of the barcode.

### See Also
[EnumBarcodeFormat]({{ site.dbr_java_api }}enum-barcode-format.html)
```

--------------------------------

### DataMatrixDetails Constructor with Parameters

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/datamatrix-details.md

Initializes a new instance of the DataMatrixDetails class with specified values for rows, columns, data region rows, data region columns, and data region number.

```java
public DataMatrixDetails(int rows, int columns, int dataRegionRows, int dataRegionColumns, int dataRegionNumber)
```

--------------------------------

### GetDecodedBarcodes

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcodes-unit.md

Gets all the DecodedBarcodeElement objects.

```APIDOC
## GetDecodedBarcodes

### Description
Gets all the `DecodedBarcodeElement` objects.

### Method
```csharp
DecodedBarcodeElement[] GetDecodedBarcodes()
```

### Return Value
Returns all the `DecodedBarcodeElement` objects.

### See Also
[DecodedBarcodeElement]
```

--------------------------------

### SimplifiedBarcodeReaderSettings Initialization

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/simplified-barcode-reader-settings.md

Initializes a new instance of the SimplifiedBarcodeReaderSettings class. This is the entry point for configuring the barcode reader.

```APIDOC
## __init__

### Description
Initializes a new instance of the `SimplifiedBarcodeReaderSettings` class.

### Method
```python
def __init__(self):
```
```

--------------------------------

### Get Extended Barcode Results Count - C++

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcode-element.md

Gets the total number of extended barcode results associated with the decoded barcode. Extended results provide additional information beyond the primary barcode data.

```cpp
virtual int GetExtendedBarcodeResultsCount() const = 0;
```

--------------------------------

### COneDCodeDetails Constructor

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/oned-code-details.md

Initializes a new instance of the COneDCodeDetails class. Use this to create an object to hold 1D barcode details.

```cpp
COneDCodeDetails()
```

--------------------------------

### Build Project for Linux

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/user-guide.md

Compile the C++ project on Linux using g++. Ensure all necessary Dynamsoft libraries are linked.

```bash
g++ -o DBRCPPSample DBRCPPSample.cpp -lDynamsoftCaptureVisionRouter -lDynamsoftLicense -lDynamsoftCore -lDynamsoftUtility -L ../Dist/Lib/Linux/x64 -Wl,-rpath=../Dist/Lib/Linux/x64 -std=c++11
```

--------------------------------

### getECISegments

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/decoded-barcode-element.md

Gets all the ECI segments in the barcode.

```APIDOC
## getECISegments

### Description
Gets all the ECI segments in the barcode.

### Method
```java
public ECISegment[] getECISegments()
```

### Return Value
Returns an array of [`ECISegment`]({{ site.dbr_java_api }}eci-segment.html) objects. Returns an empty array if no ECI information is present.

### See Also
- [ECISegment]({{ site.dbr_java_api }}eci-segment.html)

### Remarks
Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.
```

--------------------------------

### GetExtendedBarcodeResults

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcode-element.md

Gets all the extended barcode results.

```APIDOC
## GetExtendedBarcodeResults

### Description
Gets all the extended barcode results.

### Method
```csharp
ExtendedBarcodeResult[] GetExtendedBarcodeResults()
```

### Return Value
Gets all the extended barcode results.
```

--------------------------------

### GetText

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcode-element.md

Gets the text of the decoded barcode.

```APIDOC
## GetText

### Description
Gets the text of the decoded barcode.

### Method
```csharp
string GetText()
```

### Return Value
Returns the text of the decoded barcode.
```

--------------------------------

### PDF417Details Constructor with Parameters

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/pdf417-details.md

Initializes a new instance of the PDF417Details class with specified values for rows, columns, error correction level, and row indicator presence.

```java
public PDF417Details(int rows, int columns, int errorCorrectionLevel, int hasLeftRowIndicator, int hasRightRowIndicator)
```

--------------------------------

### GetLocation

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/candidate-barcode-zone.md

Gets the location of the candidate barcode.

```APIDOC
## GetLocation

### Description
Gets the location of the candidate barcode.

### Method
```csharp
Quadrilateral GetLocation()
```

### Return value
Returns the location of the candidate barcode.

### See Also
[Quadrilateral]({{ site.dcvb_dotnet_api }}core/basic-classes/quadrilateral.html)
```

--------------------------------

### Import Utility Namespace for Multi-Image Processing

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/user-guide.md

Include the Dynamsoft.Utility namespace when preparing to process multiple images.

```csharp
using Dynamsoft.Utility;
```

--------------------------------

### GetOriginalImageTag

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcodes-result.md

Gets the tag of the original image.

```APIDOC
## GetOriginalImageTag

### Description
Gets the tag of the original image.

### Method
```cpp
GetOriginalImageTag()
```

### Return value
Gets the tag of the original image.
```

--------------------------------

### QRCodeDetails Default Constructor

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/qr-code-details.md

Initializes a new instance of the QRCodeDetails class with default values.

```java
public QRCodeDetails()
```

--------------------------------

### GetFormatString

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcode-element.md

Gets the string representation of the barcode format.

```APIDOC
## GetFormatString

### Description
Gets the string representation of the barcode format.

### Method
```csharp
string GetFormatString()
```

### Return Value
Returns the string representation of the barcode format.
```

--------------------------------

### GetDeformationResistedBarcode

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/deformation-resisted-barcode-image-unit.md

Gets the deformation resisted barcode object.

```APIDOC
## GetDeformationResistedBarcode

### Description
Gets the deformation resisted barcode object.

### Method
```csharp
DeformationResistedBarcode GetDeformationResistedBarcode()
```

### Return value
Returns an instance of `DeformationResistedBarcode`.
```

--------------------------------

### Initialize License Key

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/user-guide.md

Initialize the license key for Dynamsoft Barcode Reader. A network connection is required for the public trial license.

```cpp
char errorMsg[512];
CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", errorMsg, 512);
```

--------------------------------

### DataMatrixDetails Constructors

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/datamatrix-details.md

Provides details on how to instantiate the DataMatrixDetails class, either with default values or with specific barcode measurements.

```APIDOC
## DataMatrixDetails()

### Description
Default constructor. Initializes a new instance of the DataMatrixDetails class with default values (-1, -1, -1, -1, -1).

### Constructor
`public DataMatrixDetails()`
```

```APIDOC
## DataMatrixDetails(int rows, int columns, int dataRegionRows, int dataRegionColumns, int dataRegionNumber)

### Description
Constructor with parameters. Initializes a new instance of the DataMatrixDetails class with specified values.

### Constructor
`public DataMatrixDetails(int rows, int columns, int dataRegionRows, int dataRegionColumns, int dataRegionNumber)`

### Parameters
* **rows** (int) - The row count of the DataMatrix barcode.
* **columns** (int) - The column count of the DataMatrix barcode.
* **dataRegionRows** (int) - The data region row count of the DataMatrix barcode.
* **dataRegionColumns** (int) - The data region column count of the DataMatrix barcode.
* **dataRegionNumber** (int) - The data region count.
```

--------------------------------

### GetDecodedBarcode

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcodes-unit.md

Gets the DecodedBarcodeElement object at the specified index.

```APIDOC
## GetDecodedBarcode

### Description
Gets the `DecodedBarcodeElement` object at the specified index.

### Method
```csharp
DecodedBarcodeElement GetDecodedBarcode(int index)
```

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the desired `DecodedBarcodeElement` object.

### Return Value
Returns the `DecodedBarcodeElement` object at the specified index.

### See Also
[DecodedBarcodeElement]
```

--------------------------------

### Start Barcode Capturing Process

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Initiate the barcode capturing process using startCapturing. Handles potential errors during the process and logs them.

```java
try {
    cvRouter.startCapturing("", true);
} catch (CaptureVisionException e) {
    if (e.getErrorCode() != EnumErrorCode.EC_OK) {
        System.out.println("Error: " + e.getErrorCode());
    }
}
```

--------------------------------

### GetCount

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcodes-unit.md

Gets the number of decoded barcodes in the unit.

```APIDOC
## GetCount

### Description
Gets the number of decoded barcodes in the unit.

### Method
```csharp
int GetCount()
```

### Return Value
Returns the number of decoded barcodes in the unit.
```

--------------------------------

### Run Python Barcode Reader Project

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

Execute the main Python script to start the barcode reading process. Ensure the script is saved and you are in the correct directory.

```python
python DBRPythonSample.py
```

--------------------------------

### GetOriginalImageHashId

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcodes-result.md

Gets the hash ID of the original image.

```APIDOC
## GetOriginalImageHashId

### Description
Gets the hash ID of the original image.

### Method
```cpp
GetOriginalImageHashId()
```

### Return value
Gets the hash ID of the original image.
```

--------------------------------

### startPatternRange Property

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/oned-code-details.md

Indicates the position of the start pattern relative to the barcode location. It is a float array of length 2, representing X coordinates as percentages.

```csharp
float[] startPatternRange
```

--------------------------------

### get_deformation_resisted_barcode

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/deformation-resisted-barcode-image-unit.md

Gets the deformation resisted barcode object from the DeformationResistedBarcodeImageUnit.

```APIDOC
## get_deformation_resisted_barcode

### Description
Gets the deformation resisted barcode object.

### Method
```python
def get_deformation_resisted_barcode(self) -> DeformationResistedBarcode:
```

### Return value
Returns an instance of `DeformationResistedBarcode`.
```

--------------------------------

### QRCodeDetails Constructors

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/qr-code-details.md

Provides information about the constructors available for the QRCodeDetails class, including the default constructor and a constructor that accepts various QR Code attributes.

```APIDOC
## QRCodeDetails()

### Description
Default constructor. Initializes a new instance of the QRCodeDetails class with default values.

### Constructor Signature
```java
public QRCodeDetails()
```

## QRCodeDetails(int rows, int columns, int errorCorrectionLevel, int version, int model, int mode, int page, int totalPage, int parityData)

### Description
Constructor with parameters. Initializes a new instance of the QRCodeDetails class with specified values.

### Method
```java
public QRCodeDetails(int rows, int columns, int errorCorrectionLevel, int version, int model, int mode, int page, int totalPage, int parityData)
```

### Parameters
* **rows** (int) - The row count of the QR Code.
* **columns** (int) - The column count of the QR Code.
* **errorCorrectionLevel** (int) - The error correction level of the QR Code.
* **version** (int) - The version of the QR Code.
* **model** (int) - Number of models of the QR Code.
* **mode** (int) - The first data encoding mode of the QR Code.
* **page** (int) - The position of the particular symbol in the Structured Append format of the QR Code.
* **totalPage** (int) - The total number of symbols to be concatenated in the Structured Append format of the QR Code.
* **parityData** (int) - The Parity Data following the Symbol Sequence Indicator.
```

--------------------------------

### getConfidence

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/localized-barcode-element.md

Gets the confidence score of the barcode localization result.

```APIDOC
## getConfidence()

### Description
Gets the confidence score of the barcode localization result. It represents the confidence that the positioning area is a barcode.

### Method
```java
public int getConfidence()
```

### Return value
Returns the confidence score of the barcode recognition result. It represents the confidence that the positioning area is a barcode.
```

--------------------------------

### getExtendedBarcodeResults

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/decoded-barcode-element.md

Gets all extended barcode results for the decoded barcode.

```APIDOC
## getExtendedBarcodeResults

### Description
Gets all extended barcode results for the decoded barcode.

### Method
```java
public ExtendedBarcodeResult[] getExtendedBarcodeResults()
```

### Return Value
Returns an array of `ExtendedBarcodeResult` objects for the decoded barcode.

### See Also
- [ExtendedBarcodeResult]({{ site.dbr_java_api }}extended-barcode-result.html)
```

--------------------------------

### Start Barcode Capturing Process

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/user-guide.md

Initiate the barcode capturing process for images in a specified folder. Check the returned error code and message for any issues.

```csharp
errorCode = cvRouter.StartCapturing(PresetTemplate.PT_READ_BARCODES, true, out errorMsg);
if (errorCode != (int)EnumErrorCode.EC_OK)
{
    Console.WriteLine("error: " + errorMsg);
}
```

--------------------------------

### getConfidence

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/decoded-barcode-element.md

Gets the confidence score of the barcode recognition result.

```APIDOC
## getConfidence

### Description
Gets the confidence score of the barcode recognition result.

### Method
```java
public int getConfidence()
```

### Return Value
Returns the confidence score of the barcode recognition result.
```

--------------------------------

### CandidateBarcodeZone Constructors

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/candidate-barcode-zone.md

Constructs a CandidateBarcodeZone object. Use the default constructor for default parameters or the parameterized constructor to specify location and possible formats.

```csharp
CandidateBarcodeZone();
```

```csharp
CandidateBarcodeZone(Quadrilateral location, ulong possibleFormats);
```

--------------------------------

### DataMatrixDetails Default Constructor

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/datamatrix-details.md

Initializes a new instance of the DataMatrixDetails class with default values (-1 for all attributes).

```java
public DataMatrixDetails()
```

--------------------------------

### operator[]

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcodes-result.md

Gets a pointer to the CBarcodeResultItem object at the specified index.

```APIDOC
## operator[]

### Description
Gets a pointer to the `CBarcodeResultItem` object at the specified index.

### Method
```cpp
operator[](int index)
```

### Parameters
* `index` (int) - The zero-based index of the barcode result item to retrieve.

### Return value
Returns a pointer to the `CBarcodeResultItem` object at the specified index.
```

--------------------------------

### Register Listeners for CaptureVisionRouter

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/user-guide.md

Set up input fetchers and result/state listeners for the CaptureVisionRouter instance. Ensure MyCapturedResultReceiver and MyImageSourceStateListener are properly defined.

```csharp
cvRouter.SetInput(fetcher);
CapturedResultReceiver receiver = new MyCapturedResultReceiver();
cvRouter.AddResultReceiver(receiver);
MyImageSourceStateListener listener = new MyImageSourceStateListener(cvRouter);
cvRouter.AddImageSourceStateListener(listener);
```

--------------------------------

### Get Barcode Angle

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/barcode-result-item.md

Retrieves the angle of the decoded barcode.

```cpp
virtual int GetAngle() const = 0;
```

--------------------------------

### Create CaptureVisionRouter Instance

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Instantiate the CaptureVisionRouter for barcode detection.

```java
CaptureVisionRouter cvRouter = new CaptureVisionRouter();
```

--------------------------------

### get_original_image_tag

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/decoded-barcodes-result.md

Gets the tag of the source image. Returns an ImageTag object.

```APIDOC
## get_original_image_tag

### Description
Gets the tag of the source image.

### Method
```python
def get_original_image_tag(self) -> ImageTag:
```

### Return Value
Returns an `ImageTag` object representing the tag of the source image.
```

--------------------------------

### Create CaptureVisionRouter Instance

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/user-guide.md

Instantiate the CaptureVisionRouter class, which is the main entry point for barcode capturing operations.

```python
cvr_instance = CaptureVisionRouter()

```

--------------------------------

### Include Dynamsoft Barcode Reader Headers and Libraries (C++)

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/user-guide.md

Include necessary headers and link the required libraries for Dynamsoft Barcode Reader SDK in a C++ project. This example shows platform-specific library linking for Windows.

```cpp
#include <iostream>
#include <string>
#include "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Include/DynamsoftCaptureVisionRouter.h"

using namespace std;
using namespace dynamsoft::license;
using namespace dynamsoft::cvr;
using namespace dynamsoft::dbr;

#if defined(_WIN64) || defined(_WIN32)
    #ifdef _WIN64
        #pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x64/DynamsoftCorex64.lib")
        #pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x64/DynamsoftLicensex64.lib")
        #pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x64/DynamsoftCaptureVisionRouterx64.lib")
    #else
        #pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x86/DynamsoftCorex86.lib")
        #pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x86/DynamsoftLicensex86.lib")
        #pragma comment(lib, "[INSTALLATION FOLDER]/DynamsoftBarcodeReader/Dist/Lib/Windows/x86/DynamsoftCaptureVisionRouterx86.lib")
    #endif
#endif
```

--------------------------------

### Get Barcode Text

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/python/api-reference/barcode-result-item.md

Retrieves the decoded text content of the barcode.

```python
def get_text(self) -> str:

```

--------------------------------

### GetExtendedBarcodeResultsCount

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcode-element.md

Gets the number of extended barcode results for the decoded barcode.

```APIDOC
## GetExtendedBarcodeResultsCount

### Description
Gets the number of extended barcode results for the decoded barcode.

### Method
```cpp
virtual int GetExtendedBarcodeResultsCount() const = 0;
```

### Return Value
Returns the number of extended barcode results for the decoded barcode.
```

--------------------------------

### CandidateBarcodeZonesUnit Methods

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/candidate-barcode-zones-unit.md

This section details the methods available for the CandidateBarcodeZonesUnit class, allowing users to manage candidate barcode zones within the unit.

```APIDOC
## CandidateBarcodeZonesUnit

### Description
Represents a unit containing candidate barcode zones. Inherits from `IntermediateResultUnit`.

### Methods

- **`getCount()`**: Gets the number of candidate barcode zones.
- **`getCandidateBarcodeZone(int index)`**: Gets a specific candidate barcode zone by index.
- **`getCandidateBarcodeZones()`**: Gets all candidate barcode zones.
- **`addCandidateBarcodeZone(CandidateBarcodeZone candidateBarcodeZone)`**: Adds a candidate barcode zone.
- **`removeAllCandidateBarcodeZones()`**: Removes all candidate barcode zones.
- **`removeCandidateBarcodeZone(int index)`**: Removes a candidate barcode zone at a specified index.

### Method Details

#### `getCount()`

Gets the number of candidate barcode zones in the unit.

```java
public int getCount()
```

**Return Value**

Returns the number of candidate barcode zones.

#### `getCandidateBarcodeZone(int index)`

Gets a candidate barcode zone at the specified index.

```java
public CandidateBarcodeZone getCandidateBarcodeZone(int index) throws BarcodeReaderException
```

**Parameters**

- `index` (int) - The index of the candidate barcode zone.

**Return Value**

Returns the candidate barcode zone at the specified index.

**Exceptions**

- `BarcodeReaderException`: Thrown when an error occurs.

#### `getCandidateBarcodeZones()`

Gets all candidate barcode zones.

```java
public CandidateBarcodeZone[] getCandidateBarcodeZones()
```

**Return Value**

Returns an array of all candidate barcode zones.

#### `addCandidateBarcodeZone(CandidateBarcodeZone candidateBarcodeZone)`

Adds a candidate barcode zone.

```java
public void addCandidateBarcodeZone(CandidateBarcodeZone candidateBarcodeZone) throws BarcodeReaderException
```

**Parameters**

- `candidateBarcodeZone` (CandidateBarcodeZone) - The candidate barcode zone to add.

**Exceptions**

- `BarcodeReaderException`: Thrown when an error occurs.

#### `removeAllCandidateBarcodeZones()`

Removes all the candidate barcode zones.

```java
public void removeAllCandidateBarcodeZones()
```

#### `removeCandidateBarcodeZone(int index)`

Removes a candidate barcode zone at the specified index.

```java
public void removeCandidateBarcodeZone(int index) throws BarcodeReaderException
```

**Parameters**

- `index` (int) - The index of the candidate barcode zone to remove.

**Exceptions**

- `BarcodeReaderException`: Thrown when an error occurs.

```

--------------------------------

### Import Required Classes for Multi-Image Processing

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/user-guide.md

Import necessary classes for handling image sources and barcode reading in multi-image scenarios.

```java
import com.dynamsoft.core.basic_structures.FileImageTag;
import com.dynamsoft.core.basic_structures.ImageTag;
import com.dynamsoft.cvr.*;
import com.dynamsoft.utility.DirectoryFetcher;
import com.dynamsoft.utility.UtilityException;
```

--------------------------------

### getExtendedBarcodeResultsCount

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/decoded-barcode-element.md

Gets the number of extended barcode results for the decoded barcode.

```APIDOC
## getExtendedBarcodeResultsCount

### Description
Gets the number of extended barcode results for the decoded barcode.

### Method
```java
public int getExtendedBarcodeResultsCount()
```

### Return Value
Returns the number of extended barcode results for the decoded barcode.
```

--------------------------------

### COneDCodeDetails Constructor

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/oned-code-details.md

The constructor for the COneDCodeDetails class.

```APIDOC
### COneDCodeDetails

Constructor for the COneDCodeDetails class.

```cpp
COneDCodeDetails()
```
```

--------------------------------

### GetExtendedBarcodeResultsCount

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/dotnet/api-reference/decoded-barcode-element.md

Gets the number of extended barcode results for the decoded barcode.

```APIDOC
## GetExtendedBarcodeResultsCount

### Description
Gets the number of extended barcode results for the decoded barcode.

### Method
```csharp
int GetExtendedBarcodeResultsCount()
```

### Return Value
Gets the number of extended barcode results for the decoded barcode.
```

--------------------------------

### Get Barcode Text

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/barcode-result-item.md

Retrieves the decoded text content of the barcode.

```java
public String getText()
```

--------------------------------

### OneDCodeDetails Default Constructor

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/oned-code-details.md

Initializes a new instance of the OneDCodeDetails class with default values.

```java
public OneDCodeDetails()
```

--------------------------------

### Get Possible Barcode Formats as String

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/java/api-reference/localized-barcode-element.md

Returns a string representation of all possible barcode formats, with each format separated by a comma. This provides a human-readable list of formats.

```java
public String getPossibleFormatsString()
```

--------------------------------

### GetErrorString

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcodes-result.md

Gets the error message of the recognition result, if an error occurred.

```APIDOC
## GetErrorString

### Description
Gets the error message of the recognition result, if an error occurred.

### Method
```cpp
GetErrorString()
```

### Return value
Gets the error message of the recognition result, if an error occurred.
```

--------------------------------

### GetErrorCode

Source: https://github.com/dynamsoft-docs/barcode-reader-docs-server/blob/main/programming/cplusplus/api-reference/decoded-barcodes-result.md

Gets the error code of the recognition result, if an error occurred.

```APIDOC
## GetErrorCode

### Description
Gets the error code of the recognition result, if an error occurred.

### Method
```cpp
GetErrorCode()
```

### Return value
Gets the error code of the recognition result, if an error occurred.
```