Merge pull request #43 from dynamsoft-docs/preview

update to internal commit 8ad26a38

Author: DMGithubPublisher

_config.yml

@@ -37,14 +37,14 @@ dlr_python: /label-recognition/docs/server/programming/python/
 dlr_python_api: /label-recognition/docs/server/programming/python/api-reference/
 dlr_python_release_notes: /label-recognition/docs/server/programming/python/release-notes/
 
-dcv_enumerations: /capture-vision/docs/core/enums/
-dcv_parameters_reference: /capture-vision/docs/core/parameters/reference/
-
-dcv_cpp_api: /capture-vision/docs/server/programming/cplusplus/api-reference/
-dcv_dotnet_api: /capture-vision/docs/server/programming/dotnet/api-reference/
-dcv_python_api: /capture-vision/docs/server/programming/python/api-reference/
-dcv_arch: /capture-vision/docs/core/architecture/
-dcv_introduction: /capture-vision/docs/core/introduction/
+dcvb_enumerations: /capture-vision/docs/core/enums/
+dcvb_parameters_reference: /capture-vision/docs/core/parameters/reference/
+
+dcvb_cpp_api: /capture-vision/docs/server/programming/cplusplus/api-reference/
+dcvb_dotnet_api: /capture-vision/docs/server/programming/dotnet/api-reference/
+dcvb_python_api: /capture-vision/docs/server/programming/python/api-reference/
+dcvb_arch: /capture-vision/docs/core/architecture/
+dcvb_introduction: /capture-vision/docs/core/introduction/
 
 assets: /label-recognition/docs/server/assets/
 edit_icon: /label-recognition/docs/server/assets/img-icon/edit-icon.png

programming/cplusplus/api-reference/localized-text-line-element.md

@@ -23,7 +23,7 @@ The `CLocalizedTextLineElement` class represents a localized text line element.
 class CLocalizedTextLineElement : public CRegionObjectElement
 ```
 
-*Inheritance:* [CRegionObjectElement]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -> CLocalizedTextLineElement
+*Inheritance:* [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html) -> CLocalizedTextLineElement
 
 ## Methods
 

programming/cplusplus/api-reference/localized-text-lines-unit.md

@@ -23,7 +23,7 @@ The `CLocalizedTextLinesUnit` class represents a unit that contains localized te
 class CLocalizedTextLinesUnit : public CIntermediateResultUnit
 ```
 
-*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLocalizedTextLinesUnit
+*Inheritance:* [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLocalizedTextLinesUnit
 
 ## Methods
 

programming/cplusplus/api-reference/raw-text-line-v2.6.1000.md

@@ -148,7 +148,7 @@ Returns the status of the text line.
 
 **See also**
 
-* [RawTextLineStatus]({{ site.dcv_enumerations }}label-recognizer/raw-text-line-status.html?lang=cpp)
+* [RawTextLineStatus]({{ site.dcvb_enumerations }}label-recognizer/raw-text-line-status.html?lang=cpp)
 
 ### SetText
 

programming/cplusplus/api-reference/raw-text-line-v3.0.1000.md

@@ -0,0 +1,247 @@
+---
+layout: default-layout
+title: CRawTextLine - Dynamsoft Label Recognizer Classes
+description: The class CRawTextLine of Dynamsoft Label Recognizer represents a recognized raw text line.
+keywords: Recognized raw text line
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+breadcrumbText: CRawTextLine
+---
+
+# CRawTextLine
+
+The class `CRawTextLine` of Dynamsoft Label Recognizer represents a recognized raw text line in an image. It can be in one of the following states:
+
+* `RTLS_LOCALIZED`: Localized but recognition not performed.
+* `RTLS_RECOGNITION_FAILED`: Recognition failed.
+* `RTLS_RECOGNITION_SUCCEEDED`: Successfully recognized.
+
+## Definition
+
+*Namespace:* dynamsoft::dlr::intermediate_results
+
+*Assembly:* DynamsoftLabelRecognizer
+
+```cpp
+class CRawTextLine
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`GetText`](#gettext) | Gets the recognized text.|
+| [`GetConfidence`](#getconfidence) | Gets the confidence level of the recognized text.|
+| [`GetCharacterResultsCount`](#getcharacterresultscount) | Gets the number of individual character recognition results in the line.|
+| [`GetCharacterResult`](#getcharacterresult) | Gets the character recognition result at the specified index.|
+| [`GetLocation`](#getlocation) | Gets the location of the text line.|
+| [`GetRowNumber`](#getrownumber) | Gets the row number of the text line within the image.|
+| [`GetSpecificationName`](#getspecificationname) | Gets the name of the text line specification that generated this element.|
+| [`GetStatus`](#getstatus) | Gets the status of the text line.|
+| [`SetText`](#settext) | Sets the recognized text.|
+| [`SetLocation`](#setlocation) | Set the location of the text line.|
+| [`SetRowNumber`](#setrownumber) | Set the row number of the text line within the image.|
+| [`SetSpecificationName`](#setspecificationname) | Sets the name of the text line specification that generated this element.
+| [`Release`](#release) | Decreases the reference count of the CRawTextLine object.|
+| [`Clone`](#clone) | Clone the CRawTextLine object.|
+| [`SetCharacterResults`](#setcharacterresults) | Sets the character recognition results.|
+
+### GetText
+
+Gets the recognized text.
+
+```cpp
+const char* GetText() const
+```
+
+**Return value**
+
+Returns a pointer to the recognized text.
+
+### GetConfidence
+
+Gets the confidence level of the recognized text.
+
+```cpp
+int GetConfidence() const
+```
+
+**Return value**
+
+Returns an integer value representing the confidence level of the recognized text.
+
+### GetCharacterResultsCount
+
+Gets the number of individual character recognition results in the line.
+
+```cpp
+int GetCharacterResultsCount() const
+```
+
+**Return value**
+
+Returns an integer value representing the number of individual character recognition results.
+
+### GetCharacterResult
+
+Gets the character recognition result at the specified index.
+
+```cpp
+const CCharacterResult* GetCharacterResult(int index) const
+```
+
+**Parameters**
+
+`[in] index` The index of the character recognition result to retrieve.
+
+**Return value**
+
+Returns a pointer to the character recognition result.
+
+### GetLocation
+
+Gets the location of the text line.
+
+```cpp
+CQuadrilateral GetLocation() const
+```
+
+**Return value**
+
+Returns a CQuadrilateral object which represents the location of the text line.
+
+### GetRowNumber
+
+Gets the row number of the text line within the image.
+
+```cpp
+int GetRowNumber() const
+```
+
+**Return value**
+
+Returns an integer value representing the row number of the text line within the image.
+
+### GetSpecificationName
+
+Gets the name of the text line specification that generated this element.
+
+```cpp
+const char* GetSpecificationName() const
+```
+
+**Return value**
+
+Returns the name of the text line specification.
+
+### GetStatus
+
+Gets the status of the text line.
+
+```cpp
+RawTextLineStatus GetStatus() const
+```
+
+**Return value**
+
+Returns the status of the text line.
+
+**See also**
+
+* [RawTextLineStatus](enum-raw-text-line-status.md)
+
+### SetText
+
+Sets the recognized text.
+
+```cpp
+void SetText(const char* text)
+```
+
+**Parameters**
+
+`[in] text` The text to be set.
+
+
+### SetLocation
+
+Set the location of the text line.
+
+```cpp
+int SetLocation(const CQuadrilateral& location)
+```
+
+**Parameters**
+
+`[in] location` The location of the text line.
+
+** Return value**
+
+Returns 0 if successful; otherwise returns an error code.
+
+### SetRowNumber
+
+Set the row number of the text line within the image.
+
+```cpp
+void SetRowNumber(int rowNumber)
+```
+
+**Parameters**
+
+`[in] rowNumber` The row number of the text line within the image.
+
+### SetSpecificationName
+
+Sets the name of the text line specification that generated this element.
+
+```cpp
+void SetSpecificationName(const char* specificationName)
+```
+
+**Parameters**
+
+`[in] specificationName` The name of the text line specification.
+
+### Release
+
+Decreases the reference count of the CRawTextLine object.
+
+```cpp
+void Release()
+```
+
+### Clone
+
+Clone the CRawTextLine object.
+
+```cpp
+CRawTextLine* Clone() const
+```
+
+**Return value**
+
+Returns a pointer to the cloned CRawTextLine object.
+
+**Remarks**
+
+Don't forget to call `Release` after you have finished using the cloned CRawTextLine object.
+
+### SetCharacterResults
+
+Sets the character recognition results.
+
+```cpp
+int SetCharacterResults(const CCharacterResult* charArray, int charArrayLength)
+```
+
+**Parameters**
+
+`[in] charArray` The character result array.
+
+`[in] charArrayLength` The length of the character result array.
+
+**Return value**
+
+Returns 0 if successful; otherwise returns an error code.

programming/cplusplus/api-reference/raw-text-line.md

@@ -43,8 +43,9 @@ class CRawTextLine
 | [`SetLocation`](#setlocation) | Set the location of the text line.|
 | [`SetRowNumber`](#setrownumber) | Set the row number of the text line within the image.|
 | [`SetSpecificationName`](#setspecificationname) | Sets the name of the text line specification that generated this element.
-| [`Release`](#release) | Decreases the reference count of the CRawTextLine object.|
-| [`Clone`](#clone) | Clone the CRawTextLine object.|
+| [`Release`](#release) | Decreases the reference count of the `CRawTextLine` object.|
+| [`Retain`](#retain) | Increases the reference count of the `CRawTextLine` object.|
+| [`Clone`](#clone) | Clone the `CRawTextLine` object.|
 | [`SetCharacterResults`](#setcharacterresults) | Sets the character recognition results.|
 
 ### GetText
@@ -206,27 +207,39 @@ void SetSpecificationName(const char* specificationName)
 
 ### Release
 
-Decreases the reference count of the CRawTextLine object.
+Decreases the reference count of the `CRawTextLine` object.
 
 ```cpp
 void Release()
 ```
 
+### Retain
+
+Increases the reference count of the `CRawTextLine` object.
+
+```cpp
+virtual CRawTextLine* Retain() = 0;
+```
+
+**Return value**
+
+Returns a pointer to a `CRawTextLine` object.
+
 ### Clone
 
-Clone the CRawTextLine object.
+Clone the `CRawTextLine` object.
 
 ```cpp
 CRawTextLine* Clone() const
 ```
 
 **Return value**
 
-Returns a pointer to the cloned CRawTextLine object.
+Returns a pointer to the cloned `CRawTextLine` object.
 
 **Remarks**
 
-Don't forget to call `Release` after you have finished using the cloned CRawTextLine object.
+Don't forget to call `Release` after you have finished using the cloned `CRawTextLine` object.
 
 ### SetCharacterResults
 

programming/cplusplus/api-reference/raw-text-lines-unit.md

@@ -23,7 +23,7 @@ The `CRawTextLinesUnit` class represents an intermediate result unit containing
 class CRawTextLinesUnit : public CIntermediateResultUnit
 ```
 
-*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CRawTextLinesUnit
+*Inheritance:* [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CRawTextLinesUnit
 
 ## Methods
 

programming/cplusplus/api-reference/recognized-text-line-element.md

@@ -23,7 +23,7 @@ The `CRecognizedTextLineElement` class represents a line of recognized text in a
 class CRecognizedTextLineElement : public CRegionObjectElement
 ```
 
-*Inheritance:* [CRegionObjectElement]({{ site.dcv_cpp_api }}core/intermediate-results/region-object-element.html) -> CRecognizedTextLineElement
+*Inheritance:* [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html) -> CRecognizedTextLineElement
 
 ## Methods
 

programming/cplusplus/api-reference/recognized-text-lines-unit.md

@@ -23,7 +23,7 @@ The `CRecognizedTextLinesUnit` class represents an intermediate result unit cont
 class CRecognizedTextLinesUnit : public CIntermediateResultUnit
 ```
 
-*Inheritance:* [CIntermediateResultUnit]({{ site.dcv_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CRecognizedTextLinesUnit
+*Inheritance:* [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CRecognizedTextLinesUnit
 
 ## Methods Summary
 

programming/cplusplus/api-reference/simplified-label-recognizer-settings.md

@@ -39,15 +39,15 @@ typedef struct tagSimplifiedLabelRecognizerSettings
 
 ### grayscaleTransformationModes
 
-Set the grayscale transformation modes with an array of enumeration `GrayscaleTransformationMode`. View the reference page of <a href="{{ site.dcv_cpp_api}}core/enum-grayscale-transformation-mode.html?src=cpp&&lang=cpp" target="_blank">`GrayscaleTransformationMode`</a> for more detail about grayscale transformation modes.
+Set the grayscale transformation modes with an array of enumeration `GrayscaleTransformationMode`. View the reference page of <a href="{{ site.dcvb_cpp_api}}core/enum-grayscale-transformation-mode.html?src=cpp&&lang=cpp" target="_blank">`GrayscaleTransformationMode`</a> for more detail about grayscale transformation modes.
 
 ```cpp
 GrayscaleTransformationMode grayscaleTransformationModes[8];
 ```
 
 ### grayscaleEnhancementModes
 
-Set the grayscale enhancement modes with an array of enumeration `GrayscaleEnhancementMode`. View the reference page of <a href="{{ site.dcv_cpp_api}}core/enum-grayscale-enhancement-mode.html?src=cpp&&lang=cpp" target="_blank">`GrayscaleEnhancementMode`</a> for more detail about grayscale enhancement modes.
+Set the grayscale enhancement modes with an array of enumeration `GrayscaleEnhancementMode`. View the reference page of <a href="{{ site.dcvb_cpp_api}}core/enum-grayscale-enhancement-mode.html?src=cpp&&lang=cpp" target="_blank">`GrayscaleEnhancementMode`</a> for more detail about grayscale enhancement modes.
 
 ```cpp
 GrayscaleEnhancementMode grayscaleEnhancementModes[8];