Skip to content

Commit 124a72d

Browse files
Merge pull request #28 from dynamsoft-docs/preview
update to internal commit f4233f54
2 parents a3dda75 + ea5c042 commit 124a72d

File tree

2 files changed

+120
-0
lines changed

2 files changed

+120
-0
lines changed
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
layout: default-layout
3+
title: CParsedResultItem Class - Dynamsoft Code Parser SDK C++ Edition API Reference
4+
description: This page shows CParsedResultItem Class of Dynamsoft Code Parser SDK C++ Edition.
5+
keywords: CParsedResultItem, api reference, c++
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
10+
# CParsedResultItem Class
11+
12+
```cpp
13+
class dynamsoft::dcp::CParsedResultItem
14+
```
15+
16+
| Method | Description |
17+
|----------------------|-------------|
18+
| [`GetCodeType`](#getcodetype) | Gets the code type of the parsed result. |
19+
| [`GetFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. |
20+
| [`GetFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. |
21+
| [`GetFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. |
22+
| [`GetJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. |
23+
24+
## GetCodeType
25+
26+
Gets the code type of the parsed result.
27+
28+
```cpp
29+
const char* dynamsoft::dcp::CParsedResultItem::GetCodeType()
30+
```
31+
32+
**Return Value**
33+
34+
Returns a string value representing the code type.
35+
36+
## GetJsonString
37+
38+
Gets the parsed result as a JSON formatted string.
39+
40+
```cpp
41+
const char* dynamsoft::dcp::CParsedResultItem::GetJsonString()
42+
```
43+
44+
**Return Value**
45+
46+
Returns a JSON formatted string representing the parsed result.
47+
48+
## GetFieldValue
49+
50+
Gets the value of a specified field from the parsed result.
51+
52+
```cpp
53+
const char* dynamsoft::dcp::CParsedResultItem::GetFieldValue (const char* fieldName)
54+
```
55+
56+
**Parameters**
57+
58+
`[in] fieldName` The name of the field.
59+
60+
**Return Value**
61+
62+
Returns a string representing the specified field value.
63+
64+
## GetFieldMappingStatus
65+
66+
Gets the mapping status of a specified field from the parsed result.
67+
68+
```cpp
69+
MappingStatus dynamsoft::dcp::CParsedResultItem::GetFieldMappingStatus(const char* fieldName)
70+
```
71+
72+
**Parameters**
73+
74+
`[in] fieldName` The name of the field.
75+
76+
77+
**Return Value**
78+
79+
Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=cpp) enumeration value representing the mapping status of a specified field.
80+
81+
**See Also**
82+
83+
[MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=cpp)
84+
85+
## GetFieldValidationStatus
86+
87+
Gets the validation status of a specified field from the parsed result.
88+
89+
```cpp
90+
ValidationStatus dynamsoft::dcp::CParsedResultItem::GetFieldValidationStatus(const char* fieldName)
91+
```
92+
93+
**Parameters**
94+
95+
`[in] fieldName` The name of the field.
96+
97+
**Return Value**
98+
99+
Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=cpp) enumeration value representing the validation status of a specified field.
100+
101+
**See Also**
102+
103+
[ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=cpp)

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ class dynamsoft::dcp::CParsedResultItem
1818
| [`GetCodeType`](#getcodetype) | Gets the code type of the parsed result. |
1919
| [`GetFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. |
2020
| [`GetFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. |
21+
| [`GetFieldRawValue`](#getfieldrawvalue) | Gets the raw string of a specified field from the parsed result. |
2122
| [`GetFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. |
2223
| [`GetJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. |
2324
@@ -45,6 +46,22 @@ const char* dynamsoft::dcp::CParsedResultItem::GetJsonString()
4546

4647
Returns a JSON formatted string representing the parsed result.
4748

49+
## GetFieldRawValue
50+
51+
Gets the raw string of a specified field from the parsed result.
52+
53+
```cpp
54+
const char* GetFieldRawValue(const char* fieldName)
55+
```
56+
57+
**Parameters**
58+
59+
`[in] fieldName` The name of the field.
60+
61+
**Return Value**
62+
63+
Returns a string representing the specified field raw string.
64+
4865
## GetFieldValue
4966
5067
Gets the value of a specified field from the parsed result.

0 commit comments

Comments
 (0)