Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions _includes/sidelist-programming/programming-cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
<li><a href="{{ site.dbr_cpp_api }}decoded-barcodes-unit.html" class="otherLinkColour">CDecodedBarcodesUnit</a></li>
<li><a href="{{ site.dbr_cpp_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">CDeformationResistedBarcodeImageUnit</a></li>
<li><a href="{{ site.dbr_cpp_api }}deformation-resisted-barcode.html" class="otherLinkColour">CDeformationResistedBarcode</a></li>
<li><a href="{{ site.dbr_cpp_api }}eci-segment.html" class="otherLinkColour">CECISegment</a></li>
<li><a href="{{ site.dbr_cpp_api }}extended-barcode-result.html" class="otherLinkColour">CExtendedBarcodeResult</a></li>
<li><a href="{{ site.dbr_cpp_api }}localized-barcode-element.html" class="otherLinkColour">CLocalizedBarcodeElement</a></li>
<li><a href="{{ site.dbr_cpp_api }}localized-barcodes-unit.html" class="otherLinkColour">CLocalizedBarcodesUnit</a></li>
Expand Down Expand Up @@ -180,6 +181,7 @@
<li><a>Classes</a>
<ul>
<li><a href="{{ site.dcvb_cpp_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">CAbstractIntermediateResultReceiver</a></li>
<li><a href="{{ site.dcvb_cpp_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">CAuxiliaryRegionElement</a></li>
<li><a href="{{ site.dcvb_cpp_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">CBinaryImageUnit</a></li>
<li><a href="{{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html" class="otherLinkColour">CCapturedResultBase</a></li>
<li><a href="{{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html" class="otherLinkColour">CCapturedResultItem</a></li>
Expand Down Expand Up @@ -280,6 +282,12 @@
<li><a href="{{ site.dcvb_cpp_api }}license/license-module.html" class="otherLinkColour">CLicenseModule</a></li>
</ul>
</li>
<li><a>DynamsoftIdentityUtility</a>
<ul>
<li><a href="{{ site.dcvb_cpp_api }}id-utility/identity-processor.html" class="otherLinkColour">CIdentityProcessor</a></li>
<li><a href="{{ site.dcvb_cpp_api }}id-utility/identity-utility-module.html" class="otherLinkColour">CIdentityUtilityModule</a></li>
</ul>
</li>
<li><a>DynamsoftImageProcessing</a>
<ul>
<li><a href="{{ site.dcvb_cpp_api }}image-processing/image-processing-module.html" class="otherLinkColour">CImageProcessingModule</a></li>
Expand Down
8 changes: 8 additions & 0 deletions _includes/sidelist-programming/programming-dotnet.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<li><a href="{{ site.dbr_dotnet_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
<li><a href="{{ site.dbr_dotnet_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
<li><a href="{{ site.dbr_dotnet_api }}deformation-resisted-barcode.html" class="otherLinkColour">DeformationResistedBarcode</a></li>
<li><a href="{{ site.dbr_dotnet_api }}eci-segment.html" class="otherLinkColour">ECISegment</a></li>
<li><a href="{{ site.dbr_dotnet_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
<li><a href="{{ site.dbr_dotnet_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodeElement</a></li>
<li><a href="{{ site.dbr_dotnet_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
Expand Down Expand Up @@ -165,6 +166,7 @@
<li><a>Classes</a>
<ul>
<li><a href="{{ site.dcvb_dotnet_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">AbstractIntermediateResultReceiver</a></li>
<li><a href="{{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">AuxiliaryRegionElement</a></li>
<li><a href="{{ site.dcvb_dotnet_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">BinaryImageUnit</a></li>
<li><a href="{{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-base.html" class="otherLinkColour">CapturedResultBase</a></li>
<li><a href="{{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
Expand Down Expand Up @@ -264,6 +266,12 @@
<li><a href="{{ site.dcvb_dotnet_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
</ul>
</li>
<li><a>DynamsoftIdentityUtility</a>
<ul>
<li><a href="{{ site.dcvb_dotnet_api }}id-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
<li><a href="{{ site.dcvb_dotnet_api }}id-utility/identity-utility-module.html" class="otherLinkColour">IdentityUtilityModule</a></li>
</ul>
</li>
<li><a>DynamsoftImageProcessing</a>
<ul>
<li><a href="{{ site.dcvb_dotnet_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>
Expand Down
10 changes: 9 additions & 1 deletion _includes/sidelist-programming/programming-java.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html" class="otherLinkColour">IntermediateResultManager</a></li>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html" class="otherLinkColour">IntermediateResultReceiver</a></li>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/preset-template.html" class="otherLinkColour">PresetTemplate</a></li>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
</ul>
</li>
Expand All @@ -40,6 +39,7 @@
<ul>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/enum-capture-state.html" class="otherLinkColour">EnumCaptureState</a></li>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/enum-image-source-state.html" class="otherLinkColour">EnumImageSourceState</a></li>
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/enum-preset-template.html" class="otherLinkColour">EnumPresetTemplate</a></li>
</ul>
</li>
</ul>
Expand All @@ -62,6 +62,7 @@
<li><a href="{{ site.dbr_java_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
<li><a href="{{ site.dbr_java_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
<li><a href="{{ site.dbr_java_api }}deformation-resisted-barcode.html" class="otherLinkColour">DeformationResistedBarcode</a></li>
<li><a href="{{ site.dbr_java_api }}eci-segment.html" class="otherLinkColour">ECISegment</a></li>
<li><a href="{{ site.dbr_java_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
<li><a href="{{ site.dbr_java_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodeElement</a></li>
<li><a href="{{ site.dbr_java_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
Expand Down Expand Up @@ -165,6 +166,7 @@
<li><a>Classes</a>
<ul>
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">AbstractIntermediateResultReceiver</a></li>
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">AuxiliaryRegionElement</a></li>
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">BinaryImageUnit</a></li>
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/captured-result-base.html" class="otherLinkColour">CapturedResultBase</a></li>
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
Expand Down Expand Up @@ -269,6 +271,12 @@
<li><a href="{{ site.dcvb_java_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
</ul>
</li>
<li><a>DynamsoftIdentityUtility</a>
<ul>
<li><a href="{{ site.dcvb_java_api }}id-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
<li><a href="{{ site.dcvb_java_api }}id-utility/identity-utility-module.html" class="otherLinkColour">IdentityUtilityModule</a></li>
</ul>
</li>
<li><a>DynamsoftImageProcessing</a>
<ul>
<li><a href="{{ site.dcvb_java_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>
Expand Down
8 changes: 8 additions & 0 deletions _includes/sidelist-programming/programming-python.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
<li><a href="{{ site.dbr_python_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
<li><a href="{{ site.dbr_python_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
<li><a href="{{ site.dbr_python_api }}deformation-resisted-barcode.html" class="otherLinkColour">DeformationResistedBarcode</a></li>
<li><a href="{{ site.dbr_python_api }}eci-segment.html" class="otherLinkColour">ECISegment</a></li>
<li><a href="{{ site.dbr_python_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
<li><a href="{{ site.dbr_python_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodeElement</a></li>
<li><a href="{{ site.dbr_python_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
Expand Down Expand Up @@ -164,6 +165,7 @@
<li><a>Classes</a>
<ul>
<li><a href="{{ site.dcvb_python_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">AbstractIntermediateResultReceiver</a></li>
<li><a href="{{ site.dcvb_python_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">AuxiliaryRegionElement</a></li>
<li><a href="{{ site.dcvb_python_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">BinaryImageUnit</a></li>
<li><a href="{{ site.dcvb_python_api }}core/basic-classes/captured-result-base.html" class="otherLinkColour">CapturedResultBase</a></li>
<li><a href="{{ site.dcvb_python_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
Expand Down Expand Up @@ -259,6 +261,12 @@
<li><a href="{{ site.dcvb_python_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
</ul>
</li>
<li><a>DynamsoftIdentityUtility</a>
<ul>
<li><a href="{{ site.dcvb_python_api }}id-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
<li><a href="{{ site.dcvb_python_api }}id-utility/identity-utility-module.html" class="otherLinkColour">IdentityUtilityModule</a></li>
</ul>
</li>
<li><a>DynamsoftImageProcessing</a>
<ul>
<li><a href="{{ site.dcvb_python_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,7 @@
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-width-range-array.html" class="otherLinkColour">BarcodeWidthRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-bar-count-range-array.html" class="otherLinkColour">BarcodeZoneBarCountRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-min-distance-to-image-borders.html" class="otherLinkColour">BarcodeZoneMinDistanceToImageBorders</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.html" class="otherLinkColour">BarcodeZoneWidthToHeightRatioRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/code128-subset.html" class="otherLinkColour">Code128Subset</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/data-matrix-module-isotropic.html" class="otherLinkColour">DataMatrixModuleIsotropic</a></li>
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/data-matrix-size-options.html" class="otherLinkColour">DataMatrixSizeOptions</a></li>
Expand Down
2 changes: 2 additions & 0 deletions programming/cplusplus/api-reference/core/enum-error-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ typedef enum ErrorCode
EC_RECT_INVALID = -10080,
/*The template version is incompatible. Please use a compatible template.*/
EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081,
/**The portrait zone could not be located on the identity document.*/
EC_PORTRAIT_ZONE_NOT_FOUND = -10082,
/** -20000~-29999: DLS license error code. */
/** No license. */
EC_NO_LICENSE = -20000,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ typedef enum RegionObjectElementType
/**The type of subclass SourceImageElement.*/
ROET_SOURCE_IMAGE,
/**The type of subclass TargetROIElement.*/
ROET_TARGET_ROI
ROET_TARGET_ROI,
/**The type of subclass AuxiliaryRegionElement.*/
ROET_AUXILIARY_REGION
} RegionObjectElementType;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
layout: default-layout
title: class CAuxiliaryRegionElement - Dynamsoft Core Module C++ Edition API Reference
description: This page shows the C++ edition of the class CAuxiliaryRegionElement in Dynamsoft Core Module.
keywords: auxiliary region element, c++
---

# CAuxiliaryRegionElement

The `CAuxiliaryRegionElement` class represents an auxiliary region element that contains additional region information detected during processing (e.g., MRZ, portrait zones, signature areas). It inherits from the `CRegionObjectElement` class.

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

## Definition

*Namespace:* dynamsoft::intermediate_results

*Assembly:* DynamsoftCore

*Inheritance:* [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html) -> CAuxiliaryRegionElement

```cpp
class CAuxiliaryRegionElement : public CRegionObjectElement
```

## Methods

| Method | Description |
|----------------------|-------------|
| [`GetName`](#getname) | Gets the name of this auxiliary region. |
| [`GetConfidence`](#getconfidence) | Gets the confidence level of this auxiliary region detection. |
| [`SetName`](#setname) | Sets the name of this auxiliary region. |
| [`SetLocation`](#setlocation) | Sets the location of this auxiliary region. |
| [`SetConfidence`](#setconfidence) | Sets the confidence level of this auxiliary region detection. |
| **Methods Inherited from [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html):** | |
| [`GetLocation`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object element. |
| [`GetReferencedElement`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets a pointer to a referenced region object element. |
| [`GetElementType`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getelementtype) | Gets the type of the region object element. |
| [`GetImageData`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the imageData of the region object element. |
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#clone) | Clone the region object element. |
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#retain) | Increases the reference count of the `CRegionObjectElement` object. |
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#release) | Decreases the reference count of the `CRegionObjectElement` object. |

### GetName

Gets the name of this auxiliary region.

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

**Return value**

Returns a string representing the region name (e.g., "MRZ", "PortraitZone", "SignatureArea").

### GetConfidence

Gets the confidence level of this auxiliary region detection.

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

**Return value**

Returns the confidence value, typically in the range [0, 100].

### SetName

Sets the name of this auxiliary region.

```cpp
virtual void SetName(const char* name) = 0;
```

**Parameters**

`[in] name` The region name to set (e.g., "MRZ", "PortraitZone", "SignatureArea").

### SetLocation

Sets the location of this auxiliary region.

```cpp
virtual int SetLocation(const CQuadrilateral& location) = 0;
```

**Parameters**

`[in] location` A `CQuadrilateral` object defining the region boundaries.

**Return value**

Returns 0 if successful, otherwise returns an error code.

**See Also**

[CQuadrilateral]({{ site.dcvb_cpp_api }}core/basic-structures/quadrilateral.html)

### SetConfidence

Sets the confidence level of this auxiliary region detection.

```cpp
virtual void SetConfidence(int confidence) = 0;
```

**Parameters**

`[in] confidence` The confidence value to set, typically in the range [0, 100].
Loading