Skip to content

Commit 1c89104

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #100 from dynamsoft-docs/preview
update to internal commit bb33e029
2 parents a9fd2d2 + 0db838f commit 1c89104

17 files changed

+1030
-67
lines changed

‎_data/product_version.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ version_info_list_desktop:
44
- value: latest version
55
- value: 10.x
66
child:
7+
- 10.2.10_cplusplus
78
- 10.2.0_cplusplus
89
- 10.0.20_cplusplus
910
- 10.0.10_cplusplus

‎_includes/inherited-methods/captured-result-item-10.0.20.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ The following methods are inherited from class [`CCapturedResultItem`]({{ site.d
44
| Method | Description |
55
|--------|-------------|
66
| [`GetType`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettype) | Gets the type of the captured result item. |
7-
| [`GetReferencedItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Gets a pointer to the referenced item in the captured result. |
7+
| [`GetReferenceItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#getreferenceitem) | Gets a pointer to the referenced item in the captured result. |
88

‎_includes/inherited-methods/captured-result-item-v10.2.10.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
The following methods are inherited from class [`CCapturedResultItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html).
3+
4+
| Method | Description |
5+
|--------|-------------|
6+
| [`GetType`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettype) | Gets the type of the captured result item. |
7+
| [`GetReferenceItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#getreferenceitem) | Gets a pointer to the referenced item in the captured result. |
8+
| [`GetTargetROIDefName`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the `TargetROIDef` which generate current captured result item. |
9+
| [`GetTaskName`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettaskname) | Gets the name of the task which generate current captured result item. |
10+
| [`Retain`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#retain) | Increases the reference count of the `CCapturedResultItem` object. |
11+
| [`Release`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#release) | Decreases the reference count of the `CCapturedResultItem` object. |
12+
13+

‎_includes/inherited-methods/captured-result-item.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ The following methods are inherited from class [`CCapturedResultItem`]({{ site.d
44
| Method | Description |
55
|--------|-------------|
66
| [`GetType`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettype) | Gets the type of the captured result item. |
7-
| [`GetReferencedItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#getreferenceditem) | Gets a pointer to the referenced item in the captured result. |
7+
| [`GetReferenceItem`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#getreferenceitem) | Gets a pointer to the referenced item in the captured result. |
88
| [`GetTargetROIDefName`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettargetroidefname) | Gets the name of the `TargetROIDef` which generate current captured result item. |
99
| [`GetTaskName`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#gettaskname) | Gets the name of the task which generate current captured result item. |
1010
| [`Retain`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#retain) | Increases the reference count of the `CCapturedResultItem` object. |
1111
| [`Release`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#release) | Decreases the reference count of the `CCapturedResultItem` object. |
12+
| [`Clone`]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html#clone) | Clone the `CCapturedResultItem` object. |
1213

1314

‎_layouts/search-page.html‎

Lines changed: 0 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -178,57 +178,6 @@ <h1>Search</h1>
178178
$('.productMenu').css({'top': 'unset'});
179179
}
180180
}
181-
182-
$("body").delegate("#searchResult .gsc-resultsRoot a.gs-title", "click", function(e) {
183-
e.preventDefault();
184-
185-
var link = $(this).eq(0).data("ctorig")
186-
if (link.indexOf("capture-vision/docs") > 0) {
187-
var repoType = getRepoType("server", link);
188-
if (link.indexOf("?") > 0) {
189-
var arr = link.split("?")
190-
if(arr[1].indexOf("#") > 0) {
191-
var subArr = arr[1].split("#")
192-
link = link +"?product=dbr&repoType="+ repoType +"&" + arr[1]
193-
} else {
194-
link = link + "&product=dbr&repoType=" + repoType
195-
}
196-
} else {
197-
link = link + "?product=dbr&repoType=" + repoType
198-
}
199-
}
200-
window.location.href = link
201-
});
202-
203-
function getRepoType(defaultValue, link) {
204-
var lang = getCurrentUrlLang(link, true)
205-
var repoType = defaultValue
206-
if (lang) {
207-
if (lang == 'android' || lang == 'objectivec-swift') {
208-
repoType = "mobile"
209-
} else if (lang == 'javascript') {
210-
repoType = "web"
211-
} else if (lang == 'cplusplus' || lang == 'c' || lang == 'java' || lang == 'dotnet') {
212-
repoType = "server"
213-
} else {
214-
repoType = "core"
215-
}
216-
} else {
217-
if(link.indexOf("/docs/server/") > 0) {
218-
repoType = "server"
219-
}
220-
if (link.indexOf("/docs/core/") > 0) {
221-
repoType = "core"
222-
}
223-
if (link.indexOf("/docs/mobile") > 0) {
224-
repoType = "mobile"
225-
}
226-
if (link.indexOf("/docs/web/") > 0) {
227-
repoType = "web"
228-
}
229-
}
230-
return repoType
231-
}
232181
</script>
233182

234183
{%- include livehelp.html -%}

‎assets/js/dbrServerVersionSearch.json‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,75 @@
11
[
2+
{
3+
"version": "10.4.10",
4+
"matchList": {
5+
"cpp":{
6+
"dcvRepoServer": [
7+
{
8+
"path": "/programming/cplusplus/api-reference/capture-vision-router",
9+
"version": "2.4.10"
10+
},
11+
{
12+
"path": "/programming/cplusplus/api-reference/core",
13+
"version": "3.2.40"
14+
},
15+
{
16+
"path": "/programming/cplusplus/api-reference/image-processing",
17+
"version": "2.2.40"
18+
},
19+
{
20+
"path": "/programming/cplusplus/api-reference/license",
21+
"version": "3.2.30"
22+
},
23+
{
24+
"path": "/programming/cplusplus/api-reference/utility",
25+
"version": "1.2.30"
26+
}
27+
],
28+
"dcvRepoCore": [
29+
{
30+
"path": "/enums/barcode-reader",
31+
"version": "10.4.10"
32+
},
33+
{
34+
"path": "/enums/capture-vision-router",
35+
"version": "2.4.10"
36+
},
37+
{
38+
"path": "/enums/core",
39+
"version": "3.2.40"
40+
},
41+
{
42+
"path": "/parameters/reference/barcode-format-specification",
43+
"version": "10.4.10"
44+
},
45+
{
46+
"path": "/parameters/reference/barcode-reader-task-settings",
47+
"version": "10.4.10"
48+
},
49+
{
50+
"path": "/parameters/reference/capture-vision-template",
51+
"version": "2.2.40"
52+
},
53+
{
54+
"path": "/parameters/reference/global-parameter",
55+
"version": "2.2.40"
56+
},
57+
{
58+
"path": "/parameters/reference/image-parameter",
59+
"version": "2.2.40"
60+
},
61+
{
62+
"path": "/parameters/reference/image-source-options",
63+
"version": "2.2.40"
64+
},
65+
{
66+
"path": "/parameters/reference/target-roi-def",
67+
"version": "2.2.40"
68+
}
69+
]
70+
}
71+
}
72+
},
273
{
374
"version": "10.2.10",
475
"matchList": {

‎programming/cplusplus/api-reference/barcode-result-item-v10.2.10.md‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
---
2+
layout: default-layout
3+
title: CBarcodeResultItem Class - Dynamsoft Barcode Reader C++ Edition API Reference
4+
description: This page shows CBarcodeResultItem class definition of Dynamsoft Barcode Reader SDK C++ Edition.
5+
keywords: GetFormat, GetText, GetLocation, GetConfidence, GetModuleSize, CBarcodeResultItem, api reference
6+
---
7+
8+
# CBarcodeResultItem Class
9+
10+
The `CBarcodeResultItem` class represents a barcode result item decoded by barcode reader engine. It is derived from `CCapturedResultItem`.
11+
12+
## Definition
13+
14+
*Namespace:* dynamsoft::dbr
15+
16+
*Assembly:* DynamsoftBarcodeReader
17+
18+
*Inheritance:* [CCapturedResultItem]({{ site.dcv_cpp_api }}core/basic-structures/captured-result-item.html) -> CBarcodeResultItem
19+
20+
```cpp
21+
class CBarcodeResultItem : public CCapturedResultItem
22+
```
23+
24+
## Methods
25+
26+
| Method | Description |
27+
|----------------------|-------------|
28+
| [`GetFormat`](#getformat) | Gets the format of the decoded barcode result. |
29+
| [`GetFormatString`](#getformatstring) | Gets the format string of the decoded barcode result. |
30+
| [`GetText`](#gettext) | Gets the text result of the decoded barcode. |
31+
| [`GetBytes`](#getbytes) | Gets the text bytes of the decoded barcode result. |
32+
| [`GetBytesLength`](#getbyteslength) | Gets the text length of the decoded barcode result. |
33+
| [`GetLocation`](#getlocation) | Gets the location of the decoded barcode in a quadrilateral. |
34+
| [`GetConfidence`](#getconfidence) | Gets the confidence of the decoded barcode result. |
35+
| [`GetAngle`](#getangle) | Gets the angle of the decoded barcode result. |
36+
| [`GetModuleSize`](#getmodulesize) | Gets the module size of the decoded barcode result. |
37+
| [`GetDetails`](#getdetails) | Gets the details of the decoded barcode result. |
38+
| [`IsDPM`](#isdpm) | Gets whether the decoded barcode is a DPM code. |
39+
| [`IsMirrored`](#ismirrored) | Gets whether the decoded barcode is a mirrored barcode. |
40+
41+
### Inherited Methods
42+
43+
{%- include inherited-methods/captured-result-item.md -%}
44+
45+
### GetFormat
46+
47+
It is used to get the format of the decoded barcode result.
48+
49+
```cpp
50+
virtual BarcodeFormat GetFormat() const = 0;
51+
```
52+
53+
**Return value**
54+
55+
Returns the format of the decoded barcode result.
56+
57+
**See Also**
58+
59+
[Enumeration BarcodeFormat]({{ site.dcv_enumerations }}barcode-reader/barcode-format.html?src=cpp&&lang=cpp)
60+
61+
### GetFormatString
62+
63+
It is used to get the format string of the decoded barcode result.
64+
65+
```cpp
66+
virtual const char* GetFormatString() const = 0;
67+
```
68+
69+
**Return value**
70+
71+
Returns the format string of the decoded barcode result.
72+
73+
### GetText
74+
75+
It is used to get the text result of the decoded barcode.
76+
77+
```cpp
78+
virtual const char* GetText() const = 0;
79+
```
80+
81+
**Return value**
82+
83+
Returns the text result of the decoded barcode.
84+
85+
### GetBytes
86+
87+
It is used to get the text bytes of the decoded barcode result.
88+
89+
```cpp
90+
virtual unsigned char* GetBytes() const = 0;
91+
```
92+
93+
**Return value**
94+
95+
Returns the text bytes of the decoded barcode result.
96+
97+
### GetBytesLength
98+
99+
It is used to get the text bytes length of the decoded barcode result.
100+
101+
```cpp
102+
virtual int GetBytesLength() const = 0;
103+
```
104+
105+
**Return value**
106+
107+
Returns the text bytes length of the decoded barcode result.
108+
109+
### GetLocation
110+
111+
It is used to get the location of the decoded barcode in a quadrilateral.
112+
113+
```cpp
114+
virtual CQuadrilateral GetLocation() const = 0;
115+
```
116+
117+
**Return value**
118+
119+
Returns the location of the decoded barcode in a quadrilateral.
120+
121+
**See Also**
122+
123+
[CQuadrilateral]({{ site.dcv_cpp_api }}core/basic-structures/quadrilateral.html)
124+
125+
### GetConfidence
126+
127+
It is used to get the confidence of the decoded barcode result.
128+
129+
```cpp
130+
virtual int GetConfidence() const = 0;
131+
```
132+
133+
**Return value**
134+
135+
Returns the confidence of the decoded barcode result.
136+
137+
### GetAngle
138+
139+
It is used to get the angle of the decoded barcode result.
140+
141+
```cpp
142+
virtual int GetAngle() const = 0;
143+
```
144+
145+
**Return value**
146+
147+
Returns the angle of the decoded barcode result.
148+
149+
### GetModuleSize
150+
151+
It is used to get the module size of the decoded barcode result.
152+
153+
```cpp
154+
virtual int GetModuleSize() const = 0;
155+
```
156+
157+
**Return value**
158+
159+
Returns the module size of the decoded barcode result.
160+
161+
### GetDetails
162+
163+
It is used to get the details of the decoded barcode result.
164+
165+
```cpp
166+
virtual const CBarcodeDetails* GetDetails() const = 0;
167+
```
168+
169+
**Return value**
170+
171+
Returns the details of the decoded barcode result.
172+
173+
**See Also**
174+
175+
- [CAztecDetails]({{ site.dbr_cpp_api }}aztec-details.html)
176+
- [CBarcodeDetails]({{ site.dbr_cpp_api }}barcode-details.html)
177+
- [CDataMatrixDetails]({{ site.dbr_cpp_api }}datamatrix-details.html)
178+
- [COneDCodeDetails]({{ site.dbr_cpp_api }}oned-code-details.html)
179+
- [CPDF417Details]({{ site.dbr_cpp_api }}pdf417-details.html)
180+
- [CQRCodeDetails]({{ site.dbr_cpp_api }}qr-code-details.html)
181+
182+
### IsDPM
183+
184+
It is used to get whether the decoded barcode is a DPM code.
185+
186+
```cpp
187+
virtual bool IsDPM() const = 0;
188+
```
189+
190+
**Return value**
191+
192+
Returns whether the decoded barcode is a DPM code.
193+
194+
### IsMirrored
195+
196+
It is used to get whether the decoded barcode is mirrored.
197+
198+
```cpp
199+
virtual bool IsMirrored() const = 0;
200+
```
201+
202+
**Return value**
203+
204+
Returns whether the decoded barcode is mirrored.
205+

0 commit comments

Comments
 (0)