Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_ocr_result_t	scanbotsdk_ocr_result_t
	scanbotsdk_ocr_result_t class

typedef enum scanbotsdk_field_validation_status_t	scanbotsdk_field_validation_status_t
	scanbotsdk_field_validation_status_t enum

typedef enum scanbotsdk_field_data_format_t	scanbotsdk_field_data_format_t
	scanbotsdk_field_data_format_t enum

typedef struct scanbotsdk_field_parsed_data_t	scanbotsdk_field_parsed_data_t
	scanbotsdk_field_parsed_data_t class

typedef struct scanbotsdk_field_type_t	scanbotsdk_field_type_t
	scanbotsdk_field_type_t class

typedef struct scanbotsdk_field_t	scanbotsdk_field_t
	scanbotsdk_field_t class

typedef struct scanbotsdk_generic_document_type_t	scanbotsdk_generic_document_type_t
	scanbotsdk_generic_document_type_t class

typedef struct scanbotsdk_generic_document_t	scanbotsdk_generic_document_t
	scanbotsdk_generic_document_t class

Enumerations
enum	scanbotsdk_field_validation_status_t { SCANBOTSDK_FIELD_VALIDATION_STATUS_INVALID = 0 , SCANBOTSDK_FIELD_VALIDATION_STATUS_OBSTRUCTED = 1 , SCANBOTSDK_FIELD_VALIDATION_STATUS_NONE = 2 , SCANBOTSDK_FIELD_VALIDATION_STATUS_CONFIRMED = 3 , SCANBOTSDK_FIELD_VALIDATION_STATUS_INFERRED = 4 , SCANBOTSDK_FIELD_VALIDATION_STATUS_VALID = 5 , SCANBOTSDK_FIELD_VALIDATION_STATUS_IGNORED = 6 }
	scanbotsdk_field_validation_status_t enum More...

enum	scanbotsdk_field_data_format_t { SCANBOTSDK_FIELD_DATA_FORMAT_ISO_DATE = 0 , SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_ALPHA_2 = 1 , SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_ALPHA_3 = 2 , SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_NUMERIC = 3 , SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_NAME = 4 , SCANBOTSDK_FIELD_DATA_FORMAT_GENDER = 5 }
	scanbotsdk_field_data_format_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_result_create (const char text, double confidence, scanbotsdk_ocr_result_t *result)
	Creates a new instance of scanbotsdk_ocr_result with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_result_free (scanbotsdk_ocr_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_ocr_result_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_result_get_text (scanbotsdk_ocr_result_t self, const char *text)
	Returns value of text field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_result_get_confidence (scanbotsdk_ocr_result_t self, double confidence)
	Returns value of confidence field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_validation_status_t_to_string (scanbotsdk_field_validation_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_field_validation_status_t value.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_data_format_t_to_string (scanbotsdk_field_data_format_t value, const char **result)
	Returns the string representation of the given scanbotsdk_field_data_format_t value.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_parsed_data_create (scanbotsdk_field_data_format_t type, const char value, scanbotsdk_field_parsed_data_t *result)
	Creates a new instance of scanbotsdk_field_parsed_data with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_parsed_data_free (scanbotsdk_field_parsed_data_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_parsed_data_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_parsed_data_get_type (scanbotsdk_field_parsed_data_t self, scanbotsdk_field_data_format_t type)
	Returns value of type field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_parsed_data_get_value (scanbotsdk_field_parsed_data_t self, const char *value)
	Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_create (const char name, const char full_name, const char normalized_name, scanbotsdk_common_field_type_t common_type, int list_index, scanbotsdk_field_type_t *result)
	Creates a new instance of scanbotsdk_field_type with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_create_with_defaults (const char name, const char full_name, const char normalized_name, scanbotsdk_common_field_type_t common_type, scanbotsdk_field_type_t **result)
	Creates a new instance of scanbotsdk_field_type_t with given required params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_free (scanbotsdk_field_type_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_type_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_get_name (scanbotsdk_field_type_t self, const char *name)
	Returns value of name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_get_full_name (scanbotsdk_field_type_t self, const char *full_name)
	Returns value of full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_get_normalized_name (scanbotsdk_field_type_t self, const char *normalized_name)
	Returns value of normalized_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_get_common_type (scanbotsdk_field_type_t self, scanbotsdk_common_field_type_t *common_type)
	Returns value of common_type field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_type_get_list_index (scanbotsdk_field_type_t self, int *list_index)
	Returns value of list_index field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_create (scanbotsdk_field_type_t type, scanbotsdk_ocr_result_t value, double confidence_weight, scanbotsdk_image_t image, scanbotsdk_pointf_t polygon_in_root, size_t polygon_in_root_size, scanbotsdk_field_validation_status_t validation_status, scanbotsdk_field_parsed_data_t parsed_data, size_t parsed_data_size, scanbotsdk_field_t result)
	Creates a new instance of scanbotsdk_field with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_create_with_defaults (scanbotsdk_field_type_t type, scanbotsdk_ocr_result_t value, scanbotsdk_pointf_t polygon_in_root, size_t polygon_in_root_size, scanbotsdk_field_t *result)
	Creates a new instance of scanbotsdk_field_t with given required params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_free (scanbotsdk_field_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_type (scanbotsdk_field_t self, scanbotsdk_field_type_t *type)
	Returns value of type field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_value (scanbotsdk_field_t self, scanbotsdk_ocr_result_t *value)
	Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_confidence_weight (scanbotsdk_field_t self, double confidence_weight)
	Returns value of confidence_weight field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_image (scanbotsdk_field_t self, scanbotsdk_image_t *image)
	Returns value of image field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_polygon_in_root (scanbotsdk_field_t self, scanbotsdk_pointf_t *polygon_in_root)
	Returns value of polygon_in_root field of the given object. The returned value is direct view into memory, no pre-allocations needed.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_polygon_in_root_size (scanbotsdk_field_t self, size_t size)
	Returns size of polygon_in_root array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_validation_status (scanbotsdk_field_t self, scanbotsdk_field_validation_status_t validation_status)
	Returns value of validation_status field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_parsed_data (scanbotsdk_field_t self, scanbotsdk_field_parsed_data_t *parsed_data, size_t size)
	Returns value of parsed_data field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_get_parsed_data_size (scanbotsdk_field_t self, size_t size)
	Returns size of parsed_data array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_create (const char name, const char full_name, const char normalized_name, int list_index, scanbotsdk_generic_document_type_t **result)
	Creates a new instance of scanbotsdk_generic_document_type with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_create_with_defaults (const char name, const char full_name, const char normalized_name, scanbotsdk_generic_document_type_t *result)
	Creates a new instance of scanbotsdk_generic_document_type_t with given required params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_free (scanbotsdk_generic_document_type_t *object)
	Frees the memory allocated for the instance of scanbotsdk_generic_document_type_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_get_name (scanbotsdk_generic_document_type_t self, const char *name)
	Returns value of name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_get_full_name (scanbotsdk_generic_document_type_t self, const char *full_name)
	Returns value of full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_get_normalized_name (scanbotsdk_generic_document_type_t self, const char *normalized_name)
	Returns value of normalized_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_type_get_list_index (scanbotsdk_generic_document_type_t self, int *list_index)
	Returns value of list_index field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_create (scanbotsdk_generic_document_type_t type, scanbotsdk_field_t fields, size_t fields_size, scanbotsdk_generic_document_t children, size_t children_size, scanbotsdk_pointf_t quad, size_t quad_size, scanbotsdk_pointf_t quad_in_root, size_t quad_in_root_size, scanbotsdk_image_t crop, double confidence, double confidence_weight, scanbotsdk_generic_document_t **result)
	Creates a new instance of scanbotsdk_generic_document with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_create_with_defaults (scanbotsdk_generic_document_type_t type, scanbotsdk_field_t fields, size_t fields_size, scanbotsdk_generic_document_t children, size_t children_size, scanbotsdk_pointf_t quad, size_t quad_size, scanbotsdk_pointf_t quad_in_root, size_t quad_in_root_size, scanbotsdk_generic_document_t *result)
	Creates a new instance of scanbotsdk_generic_document_t with given required params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_free (scanbotsdk_generic_document_t *object)
	Frees the memory allocated for the instance of scanbotsdk_generic_document_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_type (scanbotsdk_generic_document_t self, scanbotsdk_generic_document_type_t *type)
	Returns value of type field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_fields (scanbotsdk_generic_document_t self, scanbotsdk_field_t *fields, size_t size)
	Returns value of fields field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_fields_size (scanbotsdk_generic_document_t self, size_t size)
	Returns size of fields array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_children (scanbotsdk_generic_document_t self, scanbotsdk_generic_document_t *children, size_t size)
	Returns value of children field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_children_size (scanbotsdk_generic_document_t self, size_t size)
	Returns size of children array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_quad (scanbotsdk_generic_document_t self, scanbotsdk_pointf_t *quad)
	Returns value of quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_quad_size (scanbotsdk_generic_document_t self, size_t size)
	Returns size of quad array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_quad_in_root (scanbotsdk_generic_document_t self, scanbotsdk_pointf_t *quad_in_root)
	Returns value of quad_in_root field of the given object. The returned value is direct view into memory, no pre-allocations needed.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_quad_in_root_size (scanbotsdk_generic_document_t self, size_t size)
	Returns size of quad_in_root array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_crop (scanbotsdk_generic_document_t self, scanbotsdk_image_t *crop)
	Returns value of crop field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_confidence (scanbotsdk_generic_document_t self, double confidence)
	Returns value of confidence field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_generic_document_get_confidence_weight (scanbotsdk_generic_document_t self, double confidence_weight)
	Returns value of confidence_weight field of the given object.

Typedefs

Enumerations

Functions