From 6a37afca1bd2978c997cc7852907058f99bf5b5d Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Mon, 22 Jul 2024 22:49:45 -0700 Subject: [PATCH] update to internal commit bbef8373 --- _data/product_version.yml | 10 +- assets/js/dcpServerVersionSearch.json | 91 +++++++++ .../api-reference/parsed-result-v2.0.0.md | 56 ++++- .../api-reference/parsed-result-v2.0.20.md | 56 ++++- .../api-reference/parsed-result-v2.2.10.md | 192 ++++++++++++++++++ .../cplusplus/api-reference/parsed-result.md | 65 ++++++ programming/cplusplus/release-notes/cpp-2.md | 10 + programming/cplusplus/release-notes/index.md | 1 + 8 files changed, 464 insertions(+), 17 deletions(-) create mode 100644 programming/cplusplus/api-reference/parsed-result-v2.2.10.md diff --git a/_data/product_version.yml b/_data/product_version.yml index 0419b9f..c886436 100644 --- a/_data/product_version.yml +++ b/_data/product_version.yml @@ -4,8 +4,8 @@ version_info_list_desktop: - value: latest version - value: 2.x child: - - 2.2.10 - - 2.2.0 - - 2.0.20 - - 2.0.10 - - 2.0.0 + - 2.2.10_cplusplus + - 2.2.0_cplusplus + - 2.0.20_cplusplus + - 2.0.10_cplusplus + - 2.0.0_cplusplus diff --git a/assets/js/dcpServerVersionSearch.json b/assets/js/dcpServerVersionSearch.json index 9b10fe4..2263a7b 100644 --- a/assets/js/dcpServerVersionSearch.json +++ b/assets/js/dcpServerVersionSearch.json @@ -1,4 +1,95 @@ [ + { + "version": "2.4.10", + "matchList": { + "cpp":{ + "dcvRepoServer": [ + { + "path": "/programming/cplusplus/api-reference/capture-vision-router", + "version": "2.4.10" + }, + { + "path": "/programming/cplusplus/api-reference/core", + "version": "3.2.40" + }, + { + "path": "/programming/cplusplus/api-reference/image-processing", + "version": "2.2.40" + }, + { + "path": "/programming/cplusplus/api-reference/license", + "version": "3.2.30" + }, + { + "path": "/programming/cplusplus/api-reference/utility", + "version": "1.2.30" + } + ], + "dcvRepoCore": [ + { + "path": "/enums/capture-vision-router", + "version": "2.4.10" + }, + { + "path": "/enums/code-parser", + "version": "2.4.10" + }, + { + "path": "/enums/core", + "version": "3.2.40" + }, + { + "path": "/parameters/reference/barcode-format-specification", + "version": "10.4.10" + }, + { + "path": "/parameters/reference/barcode-reader-task-settings", + "version": "10.4.10" + }, + { + "path": "/parameters/reference/capture-vision-template", + "version": "2.2.40" + }, + { + "path": "/parameters/reference/character-model", + "version": "3.4.10" + }, + { + "path": "/parameters/reference/code-parser-task-settings", + "version": "2.4.10" + }, + { + "path": "/parameters/reference/global-parameter", + "version": "2.2.40" + }, + { + "path": "/parameters/reference/image-parameter", + "version": "2.2.40" + }, + { + "path": "/parameters/reference/image-source-options", + "version": "2.2.40" + }, + { + "path": "/parameters/reference/label-recognizer-task-settings", + "version": "3.4.10" + }, + { + "path": "/parameters/reference/semantic-processing", + "version": "2.2.40" + }, + { + "path": "/parameters/reference/target-roi-def", + "version": "2.2.40" + }, + { + "path": "/parameters/reference/text-line-specification", + "version": "3.4.10" + } + ] + } + } + }, { "version": "2.2.20", "matchList": { diff --git a/programming/cplusplus/api-reference/parsed-result-v2.0.0.md b/programming/cplusplus/api-reference/parsed-result-v2.0.0.md index df50220..ae70dab 100644 --- a/programming/cplusplus/api-reference/parsed-result-v2.0.0.md +++ b/programming/cplusplus/api-reference/parsed-result-v2.0.0.md @@ -21,8 +21,10 @@ class dynamsoft::dcp::CParsedResult | [`GetItem`](#getitem) | Gets the parsed result item at the specified index. | | [`GetErrorCode`](#geterrorcode) | Gets the error code of the parsed result, if an error occurred. | | [`GetErrorString`](#geterrorstring) | Gets the error message of the parsed result, if an error occurred. | +| [`HasItem`](#hasitem) | Check if the item is present in the array. | +| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the parsed results. | -### GetSourceImageHashId +## GetSourceImageHashId Gets the hash ID of the source image. @@ -34,7 +36,7 @@ virtual const char* GetSourceImageHashId() const = 0; Returns a pointer to a null-terminated string containing the hash ID of the source image. -### GetSourceImageTag +## GetSourceImageTag Gets the tag of the source image. @@ -50,7 +52,7 @@ Returns a pointer to a CImageTag object representing the tag of the source image [CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) -### GetCount +## GetCount Gets the number of parsed result items in the parsed result. @@ -62,7 +64,7 @@ virtual int GetCount() const = 0; Returns the number of parsed result items in the parsed result. -### GetItem +## GetItem Gets the parsed result item at the specified index. @@ -78,7 +80,7 @@ virtual const CParsedResultItem* GetItem(int index) const = 0; Returns a pointer to the `CParsedResultItem` object at the specified index. -### GetErrorCode +## GetErrorCode Gets the error code of the parsed result, if an error occurred. @@ -90,7 +92,7 @@ virtual int GetErrorCode() const = 0; Returns the error code of the parsed result, or 0 if no error occurred. -### GetErrorString +## GetErrorString Gets the error message of the parsed result, if an error occurred. @@ -101,3 +103,45 @@ virtual const char* GetErrorString() const = 0; **Return value** Returns a pointer to a null-terminated string containing the error message of the parsed result, or a pointer to an empty string if no error occurred. + +## HasItem + +Check if the item is present in the array. + +```cpp +virtual bool HasItem(const CParsedResultItem* item) const = 0; +``` + +**Parameters** + +`[in] item` The specific item to be checked. + +**Return value** + +Returns a bool value indicating whether the item is present in the array or not. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## RemoveItem + +Remove a specific item from the array in the parsed results. + +```cpp +virtual int RemoveItem(const CParsedResultItem* item) = 0; +``` + +**Parameters** + +`[in] item` The specific item to be removed. + +**Return value** + +Returns an error code. Zero indicates success. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + + diff --git a/programming/cplusplus/api-reference/parsed-result-v2.0.20.md b/programming/cplusplus/api-reference/parsed-result-v2.0.20.md index f38cdf8..cc02be4 100644 --- a/programming/cplusplus/api-reference/parsed-result-v2.0.20.md +++ b/programming/cplusplus/api-reference/parsed-result-v2.0.20.md @@ -21,8 +21,10 @@ class dynamsoft::dcp::CParsedResult | [`GetItem`](#getitem) | Gets the parsed result item at the specified index. | | [`GetErrorCode`](#geterrorcode) | Gets the error code of the parsed result, if an error occurred. | | [`GetErrorString`](#geterrorstring) | Gets the error message of the parsed result, if an error occurred. | +| [`HasItem`](#hasitem) | Check if the item is present in the array. | +| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the parsed results. | -### GetOriginalImageHashId +## GetOriginalImageHashId Gets the hash ID of the source image. @@ -34,7 +36,7 @@ virtual const char* GetOriginalImageHashId() const = 0; Returns a pointer to a null-terminated string containing the hash ID of the source image. -### GetOriginalImageTag +## GetOriginalImageTag Gets the tag of the source image. @@ -50,7 +52,7 @@ Returns a pointer to a CImageTag object representing the tag of the source image [CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) -### GetItemsCount +## GetItemsCount Gets the number of parsed result items in the parsed result. @@ -62,7 +64,7 @@ virtual int GetItemsCount() const = 0; Returns the number of parsed result items in the parsed result. -### GetItem +## GetItem Gets the parsed result item at the specified index. @@ -82,7 +84,7 @@ Returns a pointer to the `CParsedResultItem` object at the specified index. [CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) -### GetErrorCode +## GetErrorCode Gets the error code of the parsed result, if an error occurred. @@ -94,7 +96,7 @@ virtual int GetErrorCode() const = 0; Returns the error code of the parsed result, or 0 if no error occurred. -### GetErrorString +## GetErrorString Gets the error message of the parsed result, if an error occurred. @@ -105,3 +107,45 @@ virtual const char* GetErrorString() const = 0; **Return value** Returns a pointer to a null-terminated string containing the error message of the parsed result, or a pointer to an empty string if no error occurred. + +## HasItem + +Check if the item is present in the array. + +```cpp +virtual bool HasItem(const CParsedResultItem* item) const = 0; +``` + +**Parameters** + +`[in] item` The specific item to be checked. + +**Return value** + +Returns a bool value indicating whether the item is present in the array or not. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## RemoveItem + +Remove a specific item from the array in the parsed results. + +```cpp +virtual int RemoveItem(const CParsedResultItem* item) = 0; +``` + +**Parameters** + +`[in] item` The specific item to be removed. + +**Return value** + +Returns an error code. Zero indicates success. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + + diff --git a/programming/cplusplus/api-reference/parsed-result-v2.2.10.md b/programming/cplusplus/api-reference/parsed-result-v2.2.10.md new file mode 100644 index 0000000..5a73b56 --- /dev/null +++ b/programming/cplusplus/api-reference/parsed-result-v2.2.10.md @@ -0,0 +1,192 @@ +--- +layout: default-layout +title: CParsedResult Class - Dynamsoft Code Parser SDK C++ Edition API Reference +description: This page shows CParsedResult Class of Dynamsoft Code Parser SDK C++ Edition. +keywords: CParsedResult, api reference, c++ +needAutoGenerateSidebar: true +--- + + +# CParsedResult Class + +```cpp +class dynamsoft::dcp::CParsedResult +``` + +| Method | Description | +|----------------------|-------------| +| [`GetOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the source image. | +| [`GetOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the source image. | +| [`GetItemsCount`](#getitemscount) | Gets the number of parsed result items in the parsed result. | +| [`GetItem`](#getitem) | Gets the parsed result item at the specified index. | +| [`GetErrorCode`](#geterrorcode) | Gets the error code of the parsed result, if an error occurred. | +| [`GetErrorString`](#geterrorstring) | Gets the error message of the parsed result, if an error occurred. | +| [`HasItem`](#hasitem) | Check if the item is present in the array. | +| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the parsed results. | +| [`Release`](#release) | Decreases the reference count of the `CParsedResult` object. | +| [`Retain`](#retain) | Increases the reference count of the `CParsedResult` object. | +| [`operator[]`](#operator) | Gets a pointer to the `CParsedResultItem` object at the specified index.| + +## GetOriginalImageHashId + +Gets the hash ID of the source image. + +```cpp +virtual const char* GetOriginalImageHashId() const = 0; +``` + +**Return value** + +Returns a pointer to a null-terminated string containing the hash ID of the source image. + +## GetOriginalImageTag + +Gets the tag of the source image. + +```cpp +virtual const CImageTag* GetOriginalImageTag() const = 0; +``` + +**Return value** + +Returns a pointer to a CImageTag object representing the tag of the source image. + +**See Also** + +[CImageTag]({{ site.dcv_cpp_api }}core/basic-structures/image-tag.html) + +## GetItemsCount + +Gets the number of parsed result items in the parsed result. + +```cpp +virtual int GetItemsCount() const = 0; +``` + +**Return value** + +Returns the number of parsed result items in the parsed result. + +## GetItem + +Gets the parsed result item at the specified index. + +```cpp +virtual const CParsedResultItem* GetItem(int index) const = 0; +``` + +**Parameters** + +`[in] index` The zero-based index of the text line result item to retrieve. + +**Return value** + +Returns a pointer to the `CParsedResultItem` object at the specified index. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## GetErrorCode + +Gets the error code of the parsed result, if an error occurred. + +```cpp +virtual int GetErrorCode() const = 0; +``` + +**Return value** + +Returns the error code of the parsed result, or 0 if no error occurred. + +## GetErrorString + +Gets the error message of the parsed result, if an error occurred. + +```cpp +virtual const char* GetErrorString() const = 0; +``` + +**Return value** + +Returns a pointer to a null-terminated string containing the error message of the parsed result, or a pointer to an empty string if no error occurred. + +## HasItem + +Check if the item is present in the array. + +```cpp +virtual bool HasItem(const CParsedResultItem* item) const = 0; +``` + +**Parameters** + +`[in] item` The specific item to be checked. + +**Return value** + +Returns a bool value indicating whether the item is present in the array or not. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## RemoveItem + +Remove a specific item from the array in the parsed results. + +```cpp +virtual int RemoveItem(const CParsedResultItem* item) = 0; +``` + +**Parameters** + +`[in] item` The specific item to be removed. + +**Return value** + +Returns an error code. Zero indicates success. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## Release + +Decreases the reference count of the `CParsedResult` object. + +```cpp +virtual void Release() = 0; +``` + +## Retain + +Increases the reference count of the `CParsedResult` object. + +```cpp +virtual CParsedResult* Retain() = 0; +``` + +**Return value** + +Returns an object of `CParsedResult`. + +## operator[] + +Gets a pointer to the `CParsedResultItem` object at the specified index. + +```cpp +virtual const CParsedResultItem* operator[](int index) const = 0; +``` + +**Parameters** + +`[in] index` The index of the parsed result item to retrieve. + +**Return value** + +Returns a pointer to the `CParsedResultItem` object at the specified index. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) diff --git a/programming/cplusplus/api-reference/parsed-result.md b/programming/cplusplus/api-reference/parsed-result.md index 696acd5..a41b97b 100644 --- a/programming/cplusplus/api-reference/parsed-result.md +++ b/programming/cplusplus/api-reference/parsed-result.md @@ -21,9 +21,12 @@ class dynamsoft::dcp::CParsedResult | [`GetItem`](#getitem) | Gets the parsed result item at the specified index. | | [`GetErrorCode`](#geterrorcode) | Gets the error code of the parsed result, if an error occurred. | | [`GetErrorString`](#geterrorstring) | Gets the error message of the parsed result, if an error occurred. | +| [`HasItem`](#hasitem) | Check if the item is present in the array. | +| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the parsed results. | | [`Release`](#release) | Decreases the reference count of the `CParsedResult` object. | | [`Retain`](#retain) | Increases the reference count of the `CParsedResult` object. | | [`operator[]`](#operator) | Gets a pointer to the `CParsedResultItem` object at the specified index.| +| [`AddItem`](#additem) | Adds a specific item to the array in the parsed result. | ## GetOriginalImageHashId @@ -109,6 +112,47 @@ virtual const char* GetErrorString() const = 0; Returns a pointer to a null-terminated string containing the error message of the parsed result, or a pointer to an empty string if no error occurred. +## HasItem + +Check if the item is present in the array. + +```cpp +virtual bool HasItem(const CParsedResultItem* item) const = 0; +``` + +**Parameters** + +`[in] item` The specific item to be checked. + +**Return value** + +Returns a bool value indicating whether the item is present in the array or not. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## RemoveItem + +Remove a specific item from the array in the parsed results. + +```cpp +virtual int RemoveItem(const CParsedResultItem* item) = 0; +``` + +**Parameters** + +`[in] item` The specific item to be removed. + +**Return value** + +Returns an error code. Zero indicates success. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + + ## Release Decreases the reference count of the `CParsedResult` object. @@ -148,3 +192,24 @@ Returns a pointer to the `CParsedResultItem` object at the specified index. **See Also** [CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + +## AddItem + +Adds a specific item to the array in the parsed result. + +```cpp +virtual int AddItem(const CParsedResultItem* item) = 0; +``` + +**Parameters** + +`[in] item` The specific item to be added. + +**Return value** + +Returns an error code. Zero indicates success. + +**See Also** + +[CParsedResultItem]({{ site.dcp_cpp_api }}parsed-result-item.html) + diff --git a/programming/cplusplus/release-notes/cpp-2.md b/programming/cplusplus/release-notes/cpp-2.md index d727b61..1c90a0b 100644 --- a/programming/cplusplus/release-notes/cpp-2.md +++ b/programming/cplusplus/release-notes/cpp-2.md @@ -8,6 +8,16 @@ needGenerateH3Content: false # Release Notes for C++ Edition - 2.x +## 2.4.10 (07/23/2024) + +### New + +- Added a new function [`AddItem`]({{ site.dcp_cpp_api }}parsed-result.html#additem) to the class [`CParsedResult`]({{ site.dcp_cpp_api }}parsed-result.html). + +### Fixed + +- Fixed a bug where the South African Driver's License might be parsed incorrectly. + ## 2.2.10 (03/01/2024) ### Improved diff --git a/programming/cplusplus/release-notes/index.md b/programming/cplusplus/release-notes/index.md index a0f1f36..06f36ab 100644 --- a/programming/cplusplus/release-notes/index.md +++ b/programming/cplusplus/release-notes/index.md @@ -8,6 +8,7 @@ needAutoGenerateSidebar: false # Release Notes - C++ Edition +- [2.4.10 (07/23/2024)](cpp-2.md#2410-07232024) - [2.2.10 (03/01/2024)](cpp-2.md#2210-03012024) - [2.2.0 (01/16/2024)](cpp-2.md#220-01162024) - [2.0.20 (10/26/2023)](cpp-2.md#2020-10262023)