Merge pull request #81 from dynamsoft-docs/preview

update to internal commit c2ec3b5f

Author: DMGithubPublisher

_includes/sidelist-programming/programming-cpp.html

@@ -161,6 +161,7 @@
                 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath lang=include.lang targetRelativePath="sidelist-code-types.html" -%}
                 <li><a>Classes</a>
                     <ul>
+                        <li><a href="{{ site.dcp_cpp_api }}code-type.html" class="otherLinkColour">CCodeType</a></li>
                         <li><a href="{{ site.dcp_cpp_api }}code-parser-module.html" class="otherLinkColour">CCodeParserModule</a></li>
                         <li><a href="{{ site.dcp_cpp_api }}parsed-result-item.html" class="otherLinkColour">CParsedResultItem</a></li>
                         <li><a href="{{ site.dcp_cpp_api }}parsed-result.html" class="otherLinkColour">CParsedResult</a></li>

_includes/sidelist-programming/programming-dotnet.html

@@ -146,6 +146,7 @@
                 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath lang=include.lang targetRelativePath="sidelist-code-types.html" -%}
                 <li><a>Classes</a>
                     <ul>
+                        <li><a href="{{ site.dcp_dotnet_api }}code-type.html" class="otherLinkColour">CodeType</a></li>
                         <li><a href="{{ site.dcp_dotnet_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
                         <li><a href="{{ site.dcp_dotnet_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
                         <li><a href="{{ site.dcp_dotnet_api }}parsed-result.html" class="otherLinkColour">ParsedResult</a></li>

_includes/sidelist-programming/programming-python.html

@@ -151,6 +151,7 @@
                 </li>
                 <li><a>Enums</a>
                     <ul>
+                        <li><a href="{{ site.dcp_python_api }}enum-code-type.html" class="otherLinkColour">EnumCodeType</a></li>
                         <li><a href="{{ site.dcp_python_api }}enum-mapping-status.html" class="otherLinkColour">EnumMappingStatus</a></li>
                         <li><a href="{{ site.dcp_python_api }}enum-validation-status.html" class="otherLinkColour">EnumValiadtionStatus</a></li>
                     </ul>

_includes/sidelist-programming/sidelist-parameters-organization.html

@@ -440,6 +440,8 @@
                 <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/enable-qr-code-model-1.html" class="otherLinkColour">EnableQRCodeModel1</a></li>
                 <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/find-uneven-module-barcode.html" class="otherLinkColour">FindUnevenModuleBarcode</a></li>
                 <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/head-module-ratio.html" class="otherLinkColour">HeadModuleRatio</a></li>
+                <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/include-implied-ai01.html" class="otherLinkColour">IncludeImpliedAI01</a></li>
+                <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/include-trailing-check-digit.html" class="otherLinkColour">IncludeTrailingCheckDigit</a></li>
                 <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/min-quiet-zone-width.html" class="otherLinkColour">MinQuietZoneWidth</a></li>
                 <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/min-ratio-of-barcode-zone-width-to-height.html" class="otherLinkColour">MinRatioOfBarcodeZoneWidthToHeight</a></li>
                 <li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/min-result-confidence.html" class="otherLinkColour">MinResultConfidence</a></li>

assets/js/dcvServerVersionSearch.json

@@ -1,4 +1,12 @@
 [
+    {
+        "version": "3.0.4000",
+        "matchVersion": {
+            "cpp": "11.0.4000",
+            "dotnet": "11.0.4000",
+            "python": "11.0.4000"
+        }
+    },
     {
         "version": "3.0.3000",
         "matchVersion": {

programming/cplusplus/api-reference/capture-vision-router/auxiliary-classes/captured-result.md

@@ -267,22 +267,6 @@ Returns a pointer to the CProcessedDocumentResult object containing the processe
 
 Do not forget to release the memory pointed to by the returned pointer.
 
-### GetNormalizedImagesResult
-
-Gets the normalized images items from the `CCapturedResult`.
-
-```cpp
-ddn::CNormalizedImagesResult* GetNormalizedImagesResult() const
-```
-
-**Return value**
-
-Returns a pointer to the CNormalizedImagesResult object containing the normalized images items.
-
-**Remarks**
-
-Do not forget to release the memory pointed to by the returned pointer.
-
 ### GetParsedResult
 
 Gets the parsed result items from the `CCapturedResult`.

programming/cplusplus/api-reference/core/enum-error-code.md

@@ -3,10 +3,6 @@ layout: default-layout
 title: ErrorCode - Dynamsoft Core Enumerations
 description: The enumeration ErrorCode of Dynamsoft Core describes all error codes.
 keywords: Error code
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-breadcrumbText: ErrorCode
 codeAutoHeight: true
 ---
 
@@ -138,6 +134,8 @@ typedef enum ErrorCode
     EC_PDF_LICENSE_NOT_FOUND = -10079,
     /**The rectangle is invalid.*/
     EC_RECT_INVALID = -10080,
+    /*The template version is incompatible. Please use a compatible template.*/
+    EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081,
     /** -20000~-29999: DLS license error code. */
     /** No license. */
     EC_NO_LICENSE = -20000,
@@ -157,6 +155,10 @@ typedef enum ErrorCode
     EC_TRIAL_LICENSE = -20010,
     /**Online license validation failed due to network issues. Using cached license information for validation*/
     EC_LICENSE_CACHE_USED = -20012,
+    /*License authentication failed: quota exceeded.*/
+    EC_LICENSE_AUTH_QUOTA_EXCEEDED = -20013,
+    /**License restriction: the number of results has exceeded the allowed limit.*/
+    EC_LICENSE_RESULTS_LIMIT_EXCEEDED = -20014,
     /** Failed to reach License Server. */
     EC_FAILED_TO_REACH_DLS = -20200,
     /** -30000~-39999: DBR error code. */

programming/cplusplus/api-reference/index.md

@@ -133,6 +133,7 @@ needAutoGenerateSidebar: false
 
 ### Classes
 
+- [`CCodeType`]({{ site.dcp_cpp_api }}code-type.html)
 - [`CCodeParserModule`]({{ site.dcp_cpp_api }}code-parser-module.html)
 - [`CParsedResultItem`]({{ site.dcp_cpp_api }}parsed-result-item.html)
 - [`CParsedResult`]({{ site.dcp_cpp_api }}parsed-result.html)

programming/cplusplus/api-reference/utility/image-io.md

@@ -24,11 +24,39 @@ class CImageIO
 
 | Method               | Description |
 |----------------------|-------------|
+| [`ReadFromBase64String`](#readfrombase64string) | Reads an image from a base64 encoded string. |
 | [`ReadFromFile`](#readfromfile) | Reads an image from a file. |
 | [`ReadFromMemory`](#readfrommemory) | Reads an image from a file in memory. |
+| [`SaveToBase64String`](#savetobase64string) | Saves an image to a base64 encoded string. |
 | [`SaveToFile`](#savetofile) | Saves an image to a file. |
 | [`SaveToMemory`](#savetomemory) | Saves an image to a file in memory. |
 
+### ReadFromBase64String
+
+Reads an image from a base64 encoded string.
+
+```cpp
+CImageData* ReadFromBase64String(const char* base64String, int* errorCode = NULL);
+```
+
+**Parameters**
+
+`[in] base64String` A base64 encoded string that represents an image.
+
+`[out] errorCode` The error code.
+
+**Return value**
+
+Returns a pointer to a `CImageData` object representing the image if succeeds, nullptr otherwise.
+
+**Remarks**
+
+If the file format is gif, pdf or tiff, we read the first page of the image file. The caller is responsible for freeing the memory allocated for the image.
+
+**See Also**
+
+[CImageData]({{ site.dcvb_cpp_api }}core/basic-structures/image-data.html)
+
 ### ReadFromFile
 
 Reads an image from a file.
@@ -69,6 +97,9 @@ CImageData* ReadFromMemory(const unsigned char* imageFileBytes, int imageFileByt
 
 `[in] imageFileBytesLength` The length of the image file in bytes.
 
+`[out] pErrorCode` The The error code.
+
+
 **Return value**
 
 Returns a pointer to a `CImageData` object representing the image if succeeds, nullptr otherwise.
@@ -81,6 +112,38 @@ If the file format is gif, pdf or tiff, we read the first page of the image file
 
 [CImageData]({{ site.dcvb_cpp_api }}core/basic-structures/image-data.html)
 
+### SaveToBase64String
+
+Saves an image to a base64 encoded string.
+
+```cpp
+int SaveToBase64String(const CImageData* imageData, ImageFileFormat imageFormat, char** base64String);
+```
+
+**Parameters**
+
+`[in] imageData` A pointer to the image data to be saved.
+
+`[in] imageFormat` The image file format to be saved.
+
+`[in] base64String` A base64 encoded string that represents an image. The string is allocated by the SDK and must be freed by calling CCoreModule::FreeBytes.
+
+**Return value**
+
+Returns an integer indicating the success of the operation. 0 indicates success, while a non-zero value indicates an error occurred.
+
+| Error Code | Value | Description |
+| :--------- | :---- | :---------- |
+| EC_NULL_POINTER | -10002 | The ImageData object is null. |
+| EC_IMGAE_DATA_INVALID | -10069 | The input ImageData object contains invalid parameter(s). |
+
+**See Also**
+
+[CImageData]({{ site.dcvb_cpp_api }}core/basic-structures/image-data.html)
+
+[ImageFileFormat]({{ site.dcvb_cpp_api }}core/enum-image-file-format.html)
+
+
 ### SaveToFile
 
 Saves an image to a file.

programming/cplusplus/api-reference/utility/image-processor.md

@@ -30,6 +30,7 @@ class CImageProcessor
 | [`ConvertToBinaryLocal`](#converttobinarylocal) | Converts the grayscale image to binary image using local (adaptive) binarization. |
 | [`ConvertToGray`](#converttogray) | Converts colour image to grayscale. |
 | [`CropImage`](#cropimage) | Crops an image. |
+| [`CropAndDeskewImage`](#cropanddeskewimage) | Crops and deskews a region from the input image based on the specified quadrilateral. |
 | [`FilterImage`](#filterimage) | Applies a specified image filter to an input image and returns the filtered result. |
 
 ### AdjustBrightness
@@ -158,6 +159,8 @@ Crops an image.
 
 ```cpp
 CImageData* CropImage(const CImageData* pImageData, const CRect& rect, int* pErrorCode = NULL)
+
+//Announced as deprecated. Use CropAndDeskewImage instead.
 CImageData* CropImage(const CImageData* pImageData, const CQuadrilateral& quad, int* pErrorCode = NULL)
 ```
 
@@ -167,7 +170,7 @@ CImageData* CropImage(const CImageData* pImageData, const CQuadrilateral& quad,
 
 `[in] rect` The rectangle to be cropped.
 
-`[in] quads` The quadrilateral to be cropped.
+`[in] quad` The quadrilateral to be cropped.
 
 `[out] pErrorCode` The error code.
 
@@ -183,6 +186,44 @@ Returns a pointer to a `CImageData` object representing the cropped image.
 
 [CQuadrilateral]({{ site.dcvb_cpp_api }}core/basic-structures/quadrilateral.html)
 
+### CropAndDeskewImage
+
+Crops and deskews a region from the input image based on the specified quadrilateral.
+
+```cpp
+CImageData* CropAndDeskewImage(const CImageData* imageData, const CQuadrilateral& quad, int dstWidth = 0, int dstHeight = 0, int padding = 0, int* errorCode = NULL);
+```
+
+**Parameters**
+
+`[in] imageData` A pointer to the source image to be cropped and deskewed.
+
+`[in] quad` A quadrilateral defining the region of interest to extract.
+
+`[in] dstWidth` (Optional) The width of the output image. If set to 0, the width and height will be automatically calculated.
+
+`[in] dstHeight` (Optional) The height of the output image. If set to 0, the width and height will be automatically calculated.
+
+`[in] padding` (Optional) Extra padding (in pixels) applied to expand the boundaries of the extracted region. Default is 0.
+
+`[out] errorCode` The error code.
+
+**Return value**
+
+Returns a pointer to a `CImageData` object representing the cropped image.
+
+**Remarks**
+
+The caller is responsible for freeing the memory allocated for the cropped image.  
+The function will automatically calculate the perspective transform matrix and use it to crop the image.  
+If the specified quadrilateral exceeds the image boundaries, white will be used to fill the exceeding area.
+
+**See Also**
+
+[CImageData]({{ site.dcvb_cpp_api }}core/basic-structures/image-data.html)
+
+[CQuadrilateral]({{ site.dcvb_cpp_api }}core/basic-structures/quadrilateral.html)
+
 ### FilterImage
 
 Applies a specified image filter to an input image and returns the filtered result.