Skip to content

Commit 37f4f9e

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #793 from dynamsoft-docs/preview
update to internal commit e1eeb289
2 parents 0e17f90 + 12a7bf2 commit 37f4f9e

12 files changed

+159
-135
lines changed

‎faq/general/ensure-no-overuse.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ The standard way(C++) to use concurrent instance license is:
2424
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", errorMsg, 512);
2525
if (errorCode != EC_OK)
2626
cout << "License initialization error: " << errorMsg << endl;
27-
CCaptureVisionRouter *cvr = new CCaptureVisionRouter;
27+
CCaptureVisionRouter *cvRouter = new CCaptureVisionRouter;
2828
// Update parameter maxParallelTasks
2929
SimplifiedCaptureVisionSettings setting;
30-
cvr->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
30+
cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
3131
setting.maxParallelTasks = licenseCount;
32-
cvr->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
32+
cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
3333
// add further process
3434
```
3535

‎license-activation/concurrent-instance-license.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: default-layout
3+
title: Concurrent Instance License Initialization - Dynamsoft Barcode Reader Licensing
4+
description: This page shows how to concurrent instance license.
5+
keywords: license initialization, concurrent instance license
6+
needAutoGenerateSidebar: false
7+
---
8+
9+
# Concurrent Instance License Initialization
10+
11+
## Get a Trial License
12+
13+
<a href="https://www.dynamsoft.com/company/contact" target="_blank">Contact us</a> to try out `Concurrent Instance License`.
14+
15+
## Get a Full License
16+
17+
<a href="https://www.dynamsoft.com/company/contact" target="_blank">Contact us</a> to purchase a full license.
18+
19+
## Set the License In the Code
20+
21+
The following shows how to set the license in the code.
22+
23+
<div class="sample-code-prefix template2"></div>
24+
>- C++
25+
>- C#
26+
>- Python
27+
>
28+
>
29+
```cpp
30+
int licenseCount = YOUR-PURCHASED-LICENSE-COUNT;
31+
int errorCode = 1;
32+
char errorMsg[512];
33+
// Set the license count you purchased
34+
SetMaxConcurrentInstanceCount(licenseCount);
35+
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", errorMsg, 512);
36+
if (errorCode != EC_OK)
37+
cout << "License initialization error: " << errorMsg << endl;
38+
CCaptureVisionRouter *cvRouter = new CCaptureVisionRouter;
39+
// Update parameter maxParallelTasks
40+
SimplifiedCaptureVisionSettings setting;
41+
cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
42+
setting.maxParallelTasks = licenseCount;
43+
cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
44+
// add further process
45+
// CCapturedResult *result = cvRouter->Capture("IMAGE-FILE", CPresetTemplate::PT_READ_BARCODES);
46+
```
47+
>
48+
```csharp
49+
int licenseCount = YOUR-PURCHASED-LICENSE-COUNT;
50+
int errorCode = 0;
51+
string errorMsg;
52+
errorCode = LicenseManager.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
53+
LicenseManager.SetMaxConcurrentInstanceCount(licenseCount)
54+
if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_LICENSE_CACHE_USED)
55+
{
56+
Console.WriteLine("License initialization error: " + errorMsg);
57+
}
58+
else
59+
{
60+
CaptureVisionRouter cvRouter = new CaptureVisionRouter();
61+
SimplifiedCaptureVisionSettings settings;
62+
cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
63+
setting.maxParallelTasks = licenseCount;
64+
cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
65+
// add code for further process
66+
// CapturedResult result = cvRouter.Capture("IMAGE-FILE", PresetTemplate.PT_READ_BARCODES);
67+
}
68+
```
69+
>
70+
```python
71+
license_count = YOUR-PURCHASED-LICENSE-COUNT
72+
LicenseManager.set_max_concurrent_instance_count(license_count)
73+
error_code, error_msg = LicenseManager.init_license("YOUR-LICENSE-KEY")
74+
if error_code != EnumErrorCode.EC_OK and error_code != EnumErrorCode.EC_LICENSE_CACHE_USED:
75+
print("License initialization error: " + error_msg)
76+
else:
77+
cvr_instance = CaptureVisionRouter()
78+
error_code, error_msg, settings = cvr_instance.get_simplified_settings(EnumPresetTemplate.PT_READ_BARCODES)
79+
settings.max_parallel_tasks = license_count
80+
error_code, error_msg = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARCODES, settings)
81+
# add code for further process
82+
# result_array = cvr_instance.capture_multi_pages("IMAGE-FILE", EnumPresetTemplate.PT_READ_BARCODES)
83+
```

‎license-activation/index.md

+5-67
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ title: Dynamsoft Barcode Reader Licensing - Main Page
44
description: This is the main page of Dynamsoft Barcode Reader Licensing.
55
keywords: license initialization, licensing
66
needAutoGenerateSidebar: false
7-
permalink: /license-activation/index.html
87
---
98

109
# License Initialization
1110

12-
## Get a trial license
11+
## Get a Trial License
1312

1413
You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=docs){:target="_blank"} link.
1514

@@ -55,7 +54,7 @@ Dynamsoft.License.LicenseManager.initLicense("YOUR-LICENSE-KEY");
5554
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", errorMsg, 512);
5655
if (errorCode != EC_OK)
5756
cout << "License initialization error: " << errorMsg << endl;
58-
CCaptureVisionRouter *cvr = new CCaptureVisionRouter;
57+
CCaptureVisionRouter *cvRouter = new CCaptureVisionRouter;
5958
// add further process
6059
```
6160
>
@@ -69,7 +68,7 @@ Dynamsoft.License.LicenseManager.initLicense("YOUR-LICENSE-KEY");
6968
}
7069
else
7170
{
72-
CaptureVisionRouter cvr = new CaptureVisionRouter();
71+
CaptureVisionRouter cvRouter = new CaptureVisionRouter();
7372
// add code for further process
7473
}
7574
```
@@ -113,70 +112,9 @@ error_code, error_msg = LicenseManager.init_license("--Enter Your License Key He
113112
if error_code != EnumErrorCode.EC_OK.value and error_code != EnumErrorCode.EC_LICENSE_CACHE_USED.value:
114113
print("License initialization error: " + error_msg)
115114
else:
116-
CaptureVisionRouter cvr = new CaptureVisionRouter()
115+
cvr_instance = CaptureVisionRouter()
117116
# add code for further process
118117
```
119118

120-
If you are using a **concurrent instance license**, you need to apply two more operations:
119+
If you are using a `concurrent instance license`, see [Concurrent Instance License Initialization](concurrent-instance-license.html) for more information.
121120

122-
* Call method SetMaxConcurrentInstanceCount to set the license count you purchased.
123-
* Update the parameter MaxParallelTasks to align with the purchased quantity.
124-
125-
<div class="sample-code-prefix template2"></div>
126-
>- C++
127-
>- C#
128-
>- Python
129-
>
130-
>
131-
```cpp
132-
int licenseCount = YOUR-PURCHASED-LICENSE-COUNT;
133-
int errorCode = 1;
134-
char errorMsg[512];
135-
// Set the license count you purchased
136-
SetMaxConcurrentInstanceCount(licenseCount);
137-
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", errorMsg, 512);
138-
if (errorCode != EC_OK)
139-
cout << "License initialization error: " << errorMsg << endl;
140-
CCaptureVisionRouter *cvr = new CCaptureVisionRouter;
141-
// Update parameter maxParallelTasks
142-
SimplifiedCaptureVisionSettings setting;
143-
cvr->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
144-
setting.maxParallelTasks = licenseCount;
145-
cvr->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
146-
// add further process
147-
```
148-
>
149-
```csharp
150-
int licenseCount = YOUR-PURCHASED-LICENSE-COUNT;
151-
int errorCode = 0;
152-
string errorMsg;
153-
errorCode = LicenseManager.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
154-
LicenseManager.SetMaxConcurrentInstanceCount(licenseCount)
155-
if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_LICENSE_CACHE_USED)
156-
{
157-
Console.WriteLine("License initialization error: " + errorMsg);
158-
}
159-
else
160-
{
161-
CaptureVisionRouter cvr = new CaptureVisionRouter();
162-
SimplifiedCaptureVisionSettings settings;
163-
cvr.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
164-
setting.maxParallelTasks = licenseCount;
165-
cvr.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
166-
// add code for further process
167-
}
168-
```
169-
>
170-
```python
171-
license_count = YOUR-PURCHASED-LICENSE-COUNT
172-
LicenseManager.set_max_concurrent_instance_count(license_count)
173-
error_code, error_msg = LicenseManager.init_license("YOUR-LICENSE-KEY")
174-
if error_code != EnumErrorCode.EC_OK.value and error_code != EnumErrorCode.EC_LICENSE_CACHE_USED.value:
175-
print("License initialization error: " + error_msg)
176-
else:
177-
CaptureVisionRouter cvr = new CaptureVisionRouter()
178-
error_code, error_msg, settings = cvr.get_simplified_settings(EnumPresetTemplate.PT_READ_BARCODES.value)
179-
settings.max_parallel_tasks = license_count
180-
error_code, error_msg = cvr.update_settings(EnumPresetTemplate.PT_READ_BARCODES.value, settings)
181-
# add code for further process
182-
```

‎programming/features/barcode-formats-and-count.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ await router.updateSettings("ReadSingleBarcode", settings);
4141
```c++
4242
char szErrorMsg[256] = {0};
4343
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
44-
CCaptureVisionRouter* cvr = new CCaptureVisionRouter;
44+
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
4545
SimplifiedCaptureVisionSettings settings;
46-
cvr->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
46+
cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
4747
// Specify the barcode formats by enumeration values.
4848
// Use "|" to enable multiple barcode formats at one time.
4949
settings.barcodeSettings.barcodeFormatIds = BF_QR_CODE | BF_ONED;
5050
// Update the settings.
51-
cvr->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
51+
cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
5252
```
5353
>
5454
```java
@@ -99,17 +99,17 @@ err_code, err_str = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARC
9999
```
100100
>
101101
```csharp
102-
using (CaptureVisionRouter cvr = new CaptureVisionRouter())
102+
using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
103103
{
104104
SimplifiedCaptureVisionSettings settings;
105105
string errorMsg;
106106
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
107-
cvr.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
107+
cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
108108
// Specify the barcode formats by enumeration values.
109109
// Use "|" to enable multiple barcode formats at one time.
110110
settings.barcodeSettings.barcodeFormatIds = (ulong)(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_ONED);
111111
// Update the settings.
112-
cvr.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
112+
cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
113113
}
114114
```
115115

@@ -178,13 +178,13 @@ await router.updateSettings("ReadSingleBarcode", settings);
178178
```c++
179179
char szErrorMsg[256] = {0};
180180
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
181-
CCaptureVisionRouter* cvr = new CCaptureVisionRouter;
181+
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
182182
SimplifiedCaptureVisionSettings settings;
183-
cvr->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
183+
cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
184184
// Specify the expected barcode count.
185185
settings.barcodeSettings.expectedBarcodesCount = 1;
186186
// Update the settings.
187-
cvr->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
187+
cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
188188
```
189189
>
190190
```java
@@ -234,16 +234,16 @@ err_code, err_str = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARC
234234
```
235235
>
236236
```csharp
237-
using (CaptureVisionRouter cvr = new CaptureVisionRouter())
237+
using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
238238
{
239239
SimplifiedCaptureVisionSettings settings;
240240
string errorMsg;
241241
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
242-
cvr.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
242+
cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
243243
// Specify the expected barcode count.
244244
settings.barcodeSettings.expectedBarcodesCount = 1;
245245
// Update the settings.
246-
cvr.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
246+
cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
247247
}
248248
```
249249

‎programming/features/barcode-scan-region.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,17 @@ cameraEnhancer.setScanRegion({
5050
```c++
5151
char szErrorMsg[256] = {0};
5252
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
53-
CCaptureVisionRouter* cvr = new CCaptureVisionRouter;
53+
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
5454
SimplifiedCaptureVisionSettings settings;
55-
cvr->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
55+
cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
5656
// Specify the ROI
5757
settings.roi.points[0].Set(10, 10);
5858
settings.roi.points[1].Set(90, 10);
5959
settings.roi.points[2].Set(90, 90);
6060
settings.roi.points[3].Set(10, 90);
6161
settings.roiMeasuredInPercentage = 1;
6262
// Update the settings.
63-
cvr->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
63+
cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
6464
```
6565
>
6666
```python
@@ -83,20 +83,20 @@ err_code, err_str = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARC
8383
```
8484
>
8585
```csharp
86-
using (CaptureVisionRouter cvr = new CaptureVisionRouter())
86+
using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
8787
{
8888
SimplifiedCaptureVisionSettings settings;
8989
string errorMsg;
9090
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
91-
cvr.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
91+
cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
9292
// Specify the ROI.
9393
settings.roiMeasuredInPercentage = 1;
9494
settings.roi.points[0].Set(10, 10);
9595
settings.roi.points[1].Set(90, 10);
9696
settings.roi.points[2].Set(90, 90);
9797
settings.roi.points[3].Set(10, 90);
9898
// Update the settings.
99-
cvr.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
99+
cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
100100
}
101101
```
102102

‎programming/features/control-terminate-phase.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ await router.updateSettings("ReadSingleBarcode", settings);
8383
```c++
8484
char szErrorMsg[256] = {0};
8585
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
86-
CCaptureVisionRouter* cvr = new CCaptureVisionRouter;
86+
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
8787
SimplifiedCaptureVisionSettings settings;
88-
cvr->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
88+
cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings);
8989
// Specify the timeout.
9090
settings.timeout = 1000;
9191
// Update the settings.
92-
cvr->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
92+
cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256);
9393
```
9494
>
9595
```python
@@ -103,16 +103,16 @@ err_code, err_str = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARC
103103
```
104104
>
105105
```csharp
106-
using (CaptureVisionRouter cvr = new CaptureVisionRouter())
106+
using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
107107
{
108108
SimplifiedCaptureVisionSettings settings;
109109
string errorMsg;
110110
// Obtain current runtime settings of `CCaptureVisionRouter` instance.
111-
cvr.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
111+
cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
112112
// Specify the timeout.
113113
settings.timeout = 1000;
114114
// Update the settings.
115-
cvr.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
115+
cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
116116
}
117117
```
118118

‎programming/features/get-barcode-location.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ for (let item of result.items) {
4141
```
4242
>
4343
```c++
44-
CCaptureVisionRouter* cvr = new CCaptureVisionRouter;
45-
CCapturedResult* result = cvr->Capture("IMAGE-FILE-PATH", CPresetTemplate::PT_READ_BARCODES);
44+
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
45+
CCapturedResult* result = cvRouter->Capture("IMAGE-FILE-PATH", CPresetTemplate::PT_READ_BARCODES);
4646
if (result->GetErrorCode() != 0) {
4747
cout << "Error: " << result->GetErrorCode() << "," << result->GetErrorString() << endl;
4848
}
@@ -115,8 +115,8 @@ func onDecodedBarcodesReceived(_ result: DecodedBarcodesResult) {
115115
```
116116
>
117117
```python
118-
cvr = CaptureVisionRouter()
119-
result = cvr.capture("IMAGE-FILE-PATH", EnumPresetTemplate.PT_READ_BARCODES.value)
118+
cvr_instance = CaptureVisionRouter()
119+
result = cvr_instance.capture("IMAGE-FILE-PATH", EnumPresetTemplate.PT_READ_BARCODES.value)
120120
if result.get_error_code() != EnumErrorCode.EC_OK:
121121
print("Error:", result.get_error_code(), result.get_error_string())
122122
barcode_result = result.get_decoded_barcodes_result()
@@ -135,10 +135,10 @@ else:
135135
```
136136
>
137137
```csharp
138-
using (CaptureVisionRouter cvr = new CaptureVisionRouter())
138+
using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
139139
{
140140
string imageFile = "IMAGE-FILE-PATH";
141-
CapturedResult? result = cvr.Capture(imageFile, PresetTemplate.PT_READ_BARCODES);
141+
CapturedResult? result = cvRouter.Capture(imageFile, PresetTemplate.PT_READ_BARCODES);
142142
if (result == null)
143143
{
144144
Console.WriteLine("No barcode detected.");

0 commit comments

Comments
 (0)