stable/c_api/_sc_parser_result_8h_source.html

#ifndef SCANDIT_PARSER_RESULT_H_

#define SCANDIT_PARSER_RESULT_H_


#include <stddef.h>


#include <Scandit/ScByteArray.h>

#include <Scandit/ScCommon.h>


SC_EXTERN_C_BEGIN


typedef struct ScOpaqueParserResult ScParserResult;


typedef struct ScOpaqueField ScField;


SC_EXPORT

void sc_parser_result_free(ScParserResult *result);


SC_EXPORT

size_t sc_parser_result_get_fields_count(ScParserResult const *result);


SC_EXPORT

ScField const *sc_parser_result_get_field_by_name(ScParserResult const *result,

                                                  char const *field_name);


SC_EXPORT

ScField const *sc_parser_result_get_field_by_index(ScParserResult const *result, size_t index);


SC_EXPORT

ScBool sc_parser_result_is_ok(ScParserResult const *result);


SC_EXPORT

ScByteArray sc_parser_result_get_error_message(ScParserResult const *result);


SC_EXPORT

ScByteArray sc_parser_result_get_json_values(ScParserResult const *result);


SC_EXPORT

ScByteArray sc_field_get_name(ScField const *field);


SC_EXPORT

ScByteArray sc_field_get_string_value(ScField const *field);


SC_EXPORT

ScByteArray sc_field_get_json_values(ScField const *field);


SC_EXPORT

ScByteArray sc_field_get_issue(ScField const *field, uint32_t index);


SC_EXPORT

size_t sc_field_get_issues_count(ScField const *field);


SC_EXTERN_C_END


#endif // SCANDIT_PARSER_RESULT_H_

ScByteArray.h
Functions to manage an array of bytes.

ScCommon.h
Common functions and data structures.

SC_EXTERN_C_BEGIN
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19

SC_EXTERN_C_END
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28

ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:167

ScByteArray
A null terminated array of bytes.

ScField
Parser result field.

ScField::sc_field_get_name
ScByteArray sc_field_get_name(ScField const *field)
Returns the name of the given field.

ScField::sc_field_get_issue
ScByteArray sc_field_get_issue(ScField const *field, uint32_t index)
Returns issue string at the given index.

ScField::sc_field_get_issues_count
size_t sc_field_get_issues_count(ScField const *field)
Returns number of issues for the given field.

ScField::sc_field_get_json_values
ScByteArray sc_field_get_json_values(ScField const *field)
Returns the json representation of the given field.

ScField::sc_field_get_string_value
ScByteArray sc_field_get_string_value(ScField const *field)
Returns the string value of the given field.

ScParserResult
Parser result.

ScParserResult::sc_parser_result_get_fields_count
size_t sc_parser_result_get_fields_count(ScParserResult const *result)
Get number of fields of this result.

ScParserResult::sc_parser_result_is_ok
ScBool sc_parser_result_is_ok(ScParserResult const *result)
Returns true when result contains a valid result, false if an error occurred during parsing.

ScParserResult::sc_parser_result_get_field_by_index
ScField const * sc_parser_result_get_field_by_index(ScParserResult const *result, size_t index)
Get the data associated with a field.

ScParserResult::sc_parser_result_get_field_by_name
ScField const * sc_parser_result_get_field_by_name(ScParserResult const *result, char const *field_name)
Get the data associated with a field.

ScParserResult::sc_parser_result_free
void sc_parser_result_free(ScParserResult *result)
Free the parsing result and any resource associated with it, including all its fields.

ScParserResult::sc_parser_result_get_error_message
ScByteArray sc_parser_result_get_error_message(ScParserResult const *result)
Retrieve error message from parser result.

ScParserResult::sc_parser_result_get_json_values
ScByteArray sc_parser_result_get_json_values(ScParserResult const *result)
Returns the json string value of the fields in a result.