SpParserResult.h
Go to the documentation of this file.
1 
10 #ifndef SCANDIT_PARSER_PARSER_RESULT_H_
11 #define SCANDIT_PARSER_PARSER_RESULT_H_
12 
13 #include <Scandit/Parser/SpCommon.h>
14 
15 SP_BEGIN_EXTERN_C
16 
22 typedef struct SpOpaqueParserResult SpParserResult;
25 
31 typedef struct SpOpaqueField SpField;
34 
42 SC_EXPORT
43 void sp_parser_result_free(SpParserResult *result);
44 
53 SC_EXPORT
54 size_t sp_parser_result_get_fields_count(SpParserResult const *result);
55 
67 SC_EXPORT
68 SpField const *sp_parser_result_get_field_by_name(SpParserResult const *result,
69  char const *field_name);
70 
81 SC_EXPORT
82 SpField const *sp_parser_result_get_field_by_index(SpParserResult const *result, size_t index);
83 
92 SC_EXPORT
93 SpBool sp_parser_result_is_ok(SpParserResult const *result);
94 
107 SC_EXPORT
108 SpData sp_parser_result_get_error_message(SpParserResult const *result);
109 
120 SC_EXPORT
121 SpData sp_parser_result_get_json_values(SpParserResult const *result);
122 
132 SC_EXPORT
133 SpData sp_field_get_name(SpField const *field);
134 
144 SC_EXPORT
145 SpData sp_field_get_string_value(SpField const *field);
146 
156 SC_EXPORT
157 SpData sp_field_get_json_values(SpField const *field);
158 
169 SC_EXPORT
170 SpData sp_field_get_issue(SpField const *field, uint32_t index);
171 
181 SC_EXPORT
182 size_t sp_field_get_issues_count(SpField const *field);
183 
184 SP_END_EXTERN_C
185 
186 #endif // SCANDIT_PARSER_PARSER_RESULT_H_
SpCommon.h
Common data structures of the Scandit Parsing Library.
SpField::sp_field_get_issues_count
size_t sp_field_get_issues_count(SpField const *field)
Returns number of issues for the given field.
SpParserResult::sp_parser_result_get_fields_count
size_t sp_parser_result_get_fields_count(SpParserResult const *result)
Get number of fields of this result.
SpParserResult::sp_parser_result_get_error_message
SpData sp_parser_result_get_error_message(SpParserResult const *result)
Retrieve error message from parser result.
SpField::sp_field_get_name
SpData sp_field_get_name(SpField const *field)
Returns the name of the given field.
SpParserResult::sp_parser_result_get_json_values
SpData sp_parser_result_get_json_values(SpParserResult const *result)
Returns the json string value of the fields in a result.
SpField
Parser result field.
SpParserResult::sp_parser_result_get_field_by_index
SpField const * sp_parser_result_get_field_by_index(SpParserResult const *result, size_t index)
Get the data associated with a field.
SpParserResult::sp_parser_result_get_field_by_name
SpField const * sp_parser_result_get_field_by_name(SpParserResult const *result, char const *field_name)
Get the data associated with a field.
SpField::sp_field_get_json_values
SpData sp_field_get_json_values(SpField const *field)
Returns the json representation of the given field.
SpData
Represents a binary blob of data, or a string of characters.
SpParserResult::sp_parser_result_is_ok
SpBool sp_parser_result_is_ok(SpParserResult const *result)
Returns true when result contains a valid result, false if an error occurred during parsing...
SpParserResult
Parser result.
SpParserResult::sp_parser_result_free
void sp_parser_result_free(SpParserResult *result)
Free the parsing result and any resource associated with it, including all its fields.
SpField::sp_field_get_string_value
SpData sp_field_get_string_value(SpField const *field)
Returns the string value of the given field.
SpField::sp_field_get_issue
SpData sp_field_get_issue(SpField const *field, uint32_t index)
Returns issue string at the given index.
Copyright (C) 2024 Scandit AG