Skip to content

Commit d50381f

Browse files
Merge pull request #57 from dynamsoft-docs/preview
update to internal commit e5bdfab1
2 parents a46d8ed + 96665e9 commit d50381f

File tree

6 files changed

+78
-22
lines changed

6 files changed

+78
-22
lines changed

_includes/dcvNav.html

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
}
1212
}
1313
</style>
14+
15+
{%- assign docHomePage = site.docHomePage -%}
16+
{%- if page.docHomePage -%}
17+
{%- assign docHomePage = page.docHomePage -%}
18+
{%- endif -%}
1419

1520
<div id="CaptureVision" class="main">
1621
<div id="CaptureVisionMenu" class="productMenu">
@@ -19,10 +24,10 @@
1924
<div class="col-xs-12">
2025
<ul class="menuList">
2126
<!---->
22-
<li class="title"><a class="orangeLink" href="{{site.overview}}">Dynamsoft Capture Vision</a></li>
27+
<li class="title"><a class="orangeLink" href="/capture-vision/docs/core/">Dynamsoft Capture Vision</a></li>
2328
<li class="item overview">
2429
<!---->
25-
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
30+
<a class="textUpperCase" href="{{docHomePage}}">Documentation</a>
2631
</li>
2732
</ul>
2833
</div>
@@ -42,10 +47,10 @@
4247
<div class="col-xs-12">
4348
<ul class="menuList">
4449
<!---->
45-
<li class="title"><a class="orangeLink" href="{{site.overview}}">Dynamsoft Capture Vision</a></li>
50+
<li class="title"><a class="orangeLink" href="/capture-vision/docs/core/">Dynamsoft Capture Vision</a></li>
4651
<li class="item overview">
4752
<!---->
48-
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
53+
<a class="textUpperCase" href="{{docHomePage}}">Documentation</a>
4954
</li>
5055
</ul>
5156
</div>

programming/cplusplus/api-reference/license/license-manager.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,6 @@ static int InitLicense(const char* pLicense, char errorMsgBuffer[] = NULL, const
5050

5151
Returns 0 if the license is initialized successfully, a negative value indicating an error otherwise.
5252

53-
**Code Snippet**
54-
55-
```cpp
56-
int errorCode = 0;
57-
char szErrorMsg[256];
58-
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", szErrorMsg, 256);
59-
if (errorCode != ErrorCode::EC_OK && errorCode != ErrorCode::EC_LICENSE_CACHE_USED)
60-
{
61-
cout << "License initialization failed: ErrorCode: " << errorCode << ", ErrorString: " << szErrorMsg << endl;
62-
}
63-
else
64-
{
65-
// other codes...
66-
}
67-
```
68-
6953
### SetDeviceFriendlyName
7054

7155
It is used to set the friendly name of the device.
@@ -82,6 +66,10 @@ static int SetDeviceFriendlyName(const char* name)
8266
8367
Returns 0 if the friendly name is set successfully, a negative value indicating an error otherwise.
8468
69+
**Remarks**
70+
71+
This function must be called before function `InitLicense` to ensure correct functionality.
72+
8573
### SetMaxConcurrentInstanceCount
8674
8775
It is used to set the maximum number of allowed instances for the given device.
@@ -98,6 +86,10 @@ static int SetMaxConcurrentInstanceCount(int countForThisDevice)
9886

9987
Returns error code (returns 0 if the function operates successfully).
10088

89+
**Remarks**
90+
91+
This function must be called before function `InitLicense` to ensure correct functionality.
92+
10193
### GetDeviceUUID
10294

10395
It is used to get the unique identifier of the device.
@@ -121,6 +113,10 @@ static int GetDeviceUUID(int uuidGenerationMethod, char uuidBuffer[] , const int
121113
122114
Returns 0 if the UUID is generated successfully, a negative value indicating an error otherwise.
123115
116+
**Remarks**
117+
118+
This function must be called before function `InitLicense` to ensure correct functionality.
119+
124120
### SetLicenseCachePath
125121
126122
It is used to set the directory path for the license cache.
@@ -137,3 +133,26 @@ static int SetLicenseCachePath(const char* directoryPath)
137133

138134
Returns 0 if the directory path is set successfully, a negative value indicating an error otherwise.
139135

136+
**Remarks**
137+
138+
This function must be called before function `InitLicense` to ensure correct functionality.
139+
140+
## Code Snippet
141+
142+
```cpp
143+
int errorCode = 0;
144+
char szErrorMsg[256];
145+
char szUUID[256];
146+
CLicenseManager::SetLicenseCachePath("DIRECTORY-PATH-FOR-LICENSE-CACHE");
147+
CLicenseManager::GetDeviceUUID(1, szUUID, 256);
148+
CLicenseManager::SetDeviceFriendlyName("FRIENDLY-NAME");
149+
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", szErrorMsg, 256);
150+
if (errorCode != ErrorCode::EC_OK && errorCode != ErrorCode::EC_LICENSE_CACHE_USED)
151+
{
152+
cout << "License initialization failed: ErrorCode: " << errorCode << ", ErrorString: " << szErrorMsg << endl;
153+
}
154+
else
155+
{
156+
// other codes...
157+
}
158+
```

programming/cplusplus/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The best way to begin with Dynamsoft Capture Vision C++ Edition is to follow the
4545
- Minimum GLIBC Version: GLIBC_2.18 or higher
4646
- Compiler: G++ 5.4 or higher
4747

48-
- MacOS (not included in the trial package, contact us to get the SDK)
48+
- macOS (not included in the trial package, contact us to get the SDK)
4949
- Supported Versions: 10.15+
5050
- Architecture: x64 and ARM 64-bit
5151

programming/cplusplus/release-notes/cpp-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ needGenerateH3Content: false
1313
### Highlights
1414

1515
- Added to-the-latest overlapping feature.
16-
- Added ARM64 and MacOS components back to the SDK.
16+
- Added ARM64 and macOS components back to the SDK.
1717
- Improved the error handling logic of methods `Capture`, `StartCapturing` and `InitLicense` to clearly report a licensing issue.
1818

1919
### Changelogs

programming/dotnet/api-reference/license/license-manager.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ static int SetDeviceFriendlyName(string name)
6868

6969
Returns 0 if the friendly name is set successfully, a negative value indicating an error otherwise.
7070

71+
**Remarks**
72+
73+
This function must be called before function `InitLicense` to ensure correct functionality.
74+
7175
**See Also**
7276

7377
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=dotnet)
@@ -88,6 +92,10 @@ static int SetMaxConcurrentInstanceCount(int countForThisDevice)
8892

8993
Returns error code (returns 0 if the function operates successfully).
9094

95+
**Remarks**
96+
97+
This function must be called before function `InitLicense` to ensure correct functionality.
98+
9199
**See Also**
92100

93101
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=dotnet)
@@ -113,6 +121,10 @@ static int GetDeviceUUID(int uuidGenerationMethod, out string uuidBuffer)
113121

114122
Returns 0 if the UUID is generated successfully, a negative value indicating an error otherwise.
115123

124+
**Remarks**
125+
126+
This function must be called before function `InitLicense` to ensure correct functionality.
127+
116128
### SetLicenseCachePath
117129

118130
Sets the directory path for the license cache.
@@ -129,6 +141,10 @@ static int SetLicenseCachePath(string directoryPath)
129141

130142
Returns 0 if the directory path is set successfully, a negative value indicating an error otherwise.
131143

144+
**Remarks**
145+
146+
This function must be called before function `InitLicense` to ensure correct functionality.
147+
132148
**See Also**
133149

134150
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=dotnet)

programming/python/api-reference/license/license-manager.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ Returns a tuple containing following elements:
7070
- `error_code` <*int*>: The error code indicating the status of the operation.
7171
- `error_message` <*str*>: A descriptive message explaining the error.
7272

73+
**Remarks**
74+
75+
This function must be called before function `init_license` to ensure correct functionality.
76+
7377
**See Also**
7478

7579
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=python)
@@ -93,6 +97,10 @@ Returns a tuple containing following elements:
9397
- `error_code` <*int*>: The error code indicating the status of the operation.
9498
- `error_message` <*str*>: A descriptive message explaining the error.
9599

100+
**Remarks**
101+
102+
This function must be called before function `init_license` to ensure correct functionality.
103+
96104
**See Also**
97105

98106
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=python)
@@ -120,6 +128,10 @@ Returns a tuple containing following elements:
120128
- `error_message` <*str*>: A descriptive message explaining the error.
121129
- `uuid` <*str*>: The unique identifier of the device.
122130

131+
**Remarks**
132+
133+
This function must be called before function `init_license` to ensure correct functionality.
134+
123135
### set_license_cache_path
124136

125137
Sets the directory path for the license cache.
@@ -139,6 +151,10 @@ Returns a tuple containing following elements:
139151
- `error_code` <*int*>: The error code indicating the status of the operation.
140152
- `error_message` <*str*>: A descriptive message explaining the error.
141153

154+
**Remarks**
155+
156+
This function must be called before function `init_license` to ensure correct functionality.
157+
142158
**See Also**
143159

144160
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=python)

0 commit comments

Comments
 (0)