Skip to content

Commit 30671c9

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #31 from dynamsoft-docs/preview
update to internal commit 02f2ffa6
2 parents 20fcd44 + e614b59 commit 30671c9

File tree

6 files changed

+188
-2
lines changed

6 files changed

+188
-2
lines changed

‎programming/cplusplus/api-reference/code-type.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default-layout
3+
title: class CCodeType - Dynamsoft Code Parser C++ Edition API Reference
4+
description: This page shows the C++ edition of the class CCodeType in Dynamsoft Code Parser Module.
5+
keywords: code type, c++
6+
---
7+
8+
# CCodeType
9+
10+
The `CCodeType` class enumerates all supported code type strings.
11+
12+
## Definition
13+
14+
*Namespace:* dynamsoft::dcp
15+
16+
*Assembly:* DynamsoftCodeParser
17+
18+
```cpp
19+
class CCodeType
20+
{
21+
public:
22+
static const char* CT_MRTD_TD1_ID; // The code type string is "MRTD_TD1_ID",
23+
static const char* CT_MRTD_TD2_ID; // The code type string is "MRTD_TD2_ID",
24+
static const char* CT_MRTD_TD2_VISA; // The code type string is "MRTD_TD2_VISA",
25+
static const char* CT_MRTD_TD3_PASSPORT; // The code type string is "MRTD_TD3_PASSPORT",
26+
static const char* CT_MRTD_TD3_VISA; // The code type string is "MRTD_TD3_VISA",
27+
static const char* CT_MRTD_TD2_FRENCH_ID; // The code type string is "MRTD_TD2_FRENCH_ID",
28+
static const char* CT_AAMVA_DL_ID; // The code type string is "AAMVA_DL_ID",
29+
static const char* CT_AAMVA_DL_ID_WITH_MAG_STRIPE; // The code type string is "AAMVA_DL_ID_WITH_MAG_STRIPE",
30+
static const char* CT_SOUTH_AFRICA_DL; // The code type string is "SOUTH_AFRICA_DL",
31+
static const char* CT_AADHAAR; // The code type string is "AADHAAR",
32+
static const char* CT_VIN; // The code type string is "VIN",
33+
static const char* CT_GS1_AI; // The code type string is "GS1_AI",
34+
};
35+
```

‎programming/cplusplus/api-reference/parsed-result-item.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ class dynamsoft::dcp::CParsedResultItem
2121
| [`GetFieldRawValue`](#getfieldrawvalue) | Gets the raw string of a specified field from the parsed result. |
2222
| [`GetFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. |
2323
| [`GetJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. |
24-
24+
| [`GetFieldCount`](#getfieldcount) | Gets the total number of parsed fields. |
25+
| [`GetFieldName`](#getfieldname) | Gets the name of a specific parsed field by its index. |
26+
2527
## GetCodeType
2628
2729
Gets the code type of the parsed result.
@@ -118,3 +120,33 @@ Returns a [ValidationStatus]({{ site.dcvb_cpp_api }}enum-validation-status.html?
118120
**See Also**
119121

120122
[ValidationStatus]({{ site.dcvb_cpp_api }}enum-validation-status.html?lang=cpp)
123+
124+
## GetFieldCount
125+
126+
Gets the total number of parsed fields.
127+
128+
```cpp
129+
int GetFieldCount()
130+
```
131+
132+
**Return Value**
133+
134+
Returns an integer representing the count of parsed fields.
135+
136+
## GetFieldName
137+
138+
Gets the name of a specific parsed field by its index.
139+
140+
```cpp
141+
const char* GetFieldName(const int index)
142+
```
143+
144+
**Parameters**
145+
146+
`[in] index` The index of the parsed field.
147+
148+
**Return Value**
149+
150+
Returns a string representing the specified field name.
151+
152+
If the field is nested, the name includes all parent fields, separated by a dot (.). The format follows this pattern: <root_field>[.<child_field1>[.<child_field2>...]]

‎programming/dotnet/api-reference/code-type.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: default-layout
3+
title: CodeType Class - Dynamsoft Code Parser Module .NET Edition API Reference
4+
description: Definition of the CodeType class in Dynamsoft Code Parser Module .NET Edition.
5+
keywords: CodeType, api reference, .NET
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# CodeType
10+
11+
The `CodeType` class enumerates all supported code type strings.
12+
13+
## Definition
14+
15+
*Namespace:* Dynamsoft.DCP
16+
17+
```csharp
18+
public static class CodeType
19+
{
20+
public static string CT_MRTD_TD1_ID; // The code type string is "MRTD_TD1_ID",
21+
public static string CT_MRTD_TD2_ID; // The code type string is "MRTD_TD2_ID",
22+
public static string CT_MRTD_TD2_VISA; // The code type string is "MRTD_TD2_VISA",
23+
public static string CT_MRTD_TD3_PASSPORT; // The code type string is "MRTD_TD3_PASSPORT",
24+
public static string CT_MRTD_TD3_VISA; // The code type string is "MRTD_TD3_VISA",
25+
public static string CT_MRTD_TD2_FRENCH_ID; // The code type string is "MRTD_TD2_FRENCH_ID",
26+
public static string CT_AAMVA_DL_ID; // The code type string is "AAMVA_DL_ID",
27+
public static string CT_AAMVA_DL_ID_WITH_MAG_STRIPE; // The code type string is "AAMVA_DL_ID_WITH_MAG_STRIPE",
28+
public static string CT_SOUTH_AFRICA_DL; // The code type string is "SOUTH_AFRICA_DL",
29+
public static string CT_AADHAAR; // The code type string is "AADHAAR",
30+
public static string CT_VIN; // The code type string is "VIN",
31+
public static string CT_GS1_AI; // The code type string is "GS1_AI",
32+
};
33+
```

‎programming/dotnet/api-reference/parsed-result-item.md‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ public class ParsedResultItem : CapturedResultItem
3131
| [`GetFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. |
3232
| [`GetFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. |
3333
| [`GetJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. |
34-
34+
| [`GetFieldCount`](#getfieldcount) | Gets the total number of parsed fields. |
35+
| [`GetFieldName`](#getfieldname) | Gets the name of a specific parsed field by its index. |
3536

3637
### GetCodeType
3738

@@ -130,3 +131,32 @@ string GetJsonString()
130131

131132
Returns a JSON formatted string representing the full parsed result.
132133

134+
## GetFieldCount
135+
136+
Gets the total number of parsed fields.
137+
138+
```csharp
139+
int GetFieldCount()
140+
```
141+
142+
**Return Value**
143+
144+
Returns an integer representing the count of parsed fields.
145+
146+
## GetFieldName
147+
148+
Gets the name of a specific parsed field by its index.
149+
150+
```csharp
151+
string GetFieldName(int index)
152+
```
153+
154+
**Parameters**
155+
156+
`[in] index` The index of the parsed field.
157+
158+
**Return Value**
159+
160+
Returns a string representing the specified field name.
161+
162+
If the field is nested, the name includes all parent fields, separated by a dot (.). The format follows this pattern: <root_field>[.<child_field1>[.<child_field2>...]]

‎programming/python/api-reference/enum-code-type.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: default-layout
3+
title: CodeType - Dynamsoft Code Parser Python Enumerations
4+
description: The enumeration CodeType of Dynamsoft Code Parser represents all supported code type strings.
5+
keywords: code type, python
6+
---
7+
8+
# CodeType
9+
10+
The `CodeType` class enumerates all supported code type strings.
11+
12+
```python
13+
class EnumCodeType(str, Enum):
14+
# The code type string is "MRTD_TD1_ID"
15+
CT_MRTD_TD1_ID
16+
# The code type string is "MRTD_TD2_ID"
17+
CT_MRTD_TD2_ID
18+
# The code type string is "MRTD_TD2_VISA"
19+
CT_MRTD_TD2_VISA
20+
# The code type string is "MRTD_TD3_PASSPORT"
21+
CT_MRTD_TD3_PASSPORT
22+
# The code type string is "MRTD_TD3_VISA"
23+
CT_MRTD_TD3_VISA
24+
# The code type string is "MRTD_TD2_FRENCH_ID"
25+
CT_MRTD_TD2_FRENCH_ID
26+
# The code type string is "AAMVA_DL_ID"
27+
CT_AAMVA_DL_ID
28+
# The code type string is "AAMVA_DL_ID_WITH_MAG_STRIPE"
29+
CT_AAMVA_DL_ID_WITH_MAG_STRIPE
30+
# The code type string is "SOUTH_AFRICA_DL"
31+
CT_SOUTH_AFRICA_DL
32+
# The code type string is "AADHAAR"
33+
CT_AADHAAR
34+
# The code type string is "VIN"
35+
CT_VIN
36+
# The code type string is "GS1_AI"
37+
CT_GS1_AI
38+
```

‎programming/python/api-reference/parsed-result-item.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ class ParsedResultItem(dynamsoft_core.CapturedResultItem)
3030
| [`get_field_validation_status`](#get_field_validation_status) | Gets the validation status of a specified field from the parsed result. |
3131
| [`get_json_string`](#get_json_string) | Gets the parsed result as a JSON formatted string. |
3232
| [`get_field_raw_value`](#get_field_raw_value) | Gets the raw string of a specified field from the parsed result. |
33+
| [`get_all_field_names`](#get_all_field_names) | Gets the names of all parsed fields. |
3334

3435
### get_code_type
3536

@@ -128,3 +129,20 @@ def get_field_raw_value(self, field_name: str) -> str:
128129

129130
Returns a string representing the specified field raw string.
130131

132+
**Return Value**
133+
134+
Returns an integer representing the count of parsed fields.
135+
136+
## get_all_field_names
137+
138+
Gets the names of all parsed fields.
139+
140+
```csharp
141+
def get_all_field_names(self)->List[str]:
142+
```
143+
144+
**Return Value**
145+
146+
Returns a list of all field names.
147+
148+
If the field is nested, the name includes all parent fields, separated by a dot (.). The format follows this pattern: <root_field>[.<child_field1>[.<child_field2>...]]

0 commit comments

Comments
 (0)