ScanbotSDKCheckScannerTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef enum scanbotsdk_check_document_detection_mode_t	scanbotsdk_check_document_detection_mode_t
	scanbotsdk_check_document_detection_mode_t enum
typedef enum scanbotsdk_check_magnetic_ink_strip_scanning_status_t	scanbotsdk_check_magnetic_ink_strip_scanning_status_t
	scanbotsdk_check_magnetic_ink_strip_scanning_status_t enum
typedef struct scanbotsdk_check_scanning_result_t	scanbotsdk_check_scanning_result_t
	scanbotsdk_check_scanning_result_t class
typedef enum scanbotsdk_check_standard_t	scanbotsdk_check_standard_t
	scanbotsdk_check_standard_t enum
typedef struct scanbotsdk_check_scanner_configuration_t	scanbotsdk_check_scanner_configuration_t
	scanbotsdk_check_scanner_configuration_t class

Enumerations
enum	scanbotsdk_check_document_detection_mode_t {   SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DISABLED = 0 ,   SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DETECT_DOCUMENT = 1 ,   SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DETECT_AND_CROP_DOCUMENT = 2 }
	scanbotsdk_check_document_detection_mode_t enum More...
enum	scanbotsdk_check_magnetic_ink_strip_scanning_status_t {   SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_SUCCESS = 0 ,   SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_INCOMPLETE_VALIDATION = 1 ,   SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_ERROR_NOTHING_FOUND = 2 }
	scanbotsdk_check_magnetic_ink_strip_scanning_status_t enum More...
enum	scanbotsdk_check_standard_t {   SCANBOTSDK_CHECK_STANDARD_USA = 0 ,   SCANBOTSDK_CHECK_STANDARD_FRA = 1 ,   SCANBOTSDK_CHECK_STANDARD_KWT = 2 ,   SCANBOTSDK_CHECK_STANDARD_AUS = 3 ,   SCANBOTSDK_CHECK_STANDARD_IND = 4 ,   SCANBOTSDK_CHECK_STANDARD_ISR = 5 ,   SCANBOTSDK_CHECK_STANDARD_UAE = 6 ,   SCANBOTSDK_CHECK_STANDARD_CAN = 7 }
	scanbotsdk_check_standard_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_document_detection_mode_t_to_string (scanbotsdk_check_document_detection_mode_t value, const char **result)
	Returns the string representation of the given scanbotsdk_check_document_detection_mode_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_magnetic_ink_strip_scanning_status_t_to_string (scanbotsdk_check_magnetic_ink_strip_scanning_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_check_magnetic_ink_strip_scanning_status_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanning_result_free (scanbotsdk_check_scanning_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_check_scanning_result_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanning_result_get_status (scanbotsdk_check_scanning_result_t *self, scanbotsdk_check_magnetic_ink_strip_scanning_status_t *status)
	Returns value of status field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanning_result_get_check (scanbotsdk_check_scanning_result_t *self, scanbotsdk_generic_document_t **check)
	Returns value of check 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_check_scanning_result_get_document_detection_result (scanbotsdk_check_scanning_result_t *self, scanbotsdk_document_detection_result_t **document_detection_result)
	Returns value of document_detection_result 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_check_scanning_result_get_cropped_image (scanbotsdk_check_scanning_result_t *self, scanbotsdk_image_t **cropped_image)
	Returns value of cropped_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_check_standard_t_to_string (scanbotsdk_check_standard_t value, const char **result)
	Returns the string representation of the given scanbotsdk_check_standard_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_create (scanbotsdk_check_document_detection_mode_t document_detection_mode, scanbotsdk_check_standard_t *accepted_check_standards, size_t accepted_check_standards_size, scanbotsdk_processing_mode_t processing_mode, scanbotsdk_check_scanner_configuration_t **result)
	Creates a new instance of scanbotsdk_check_scanner_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_create_with_defaults (scanbotsdk_check_scanner_configuration_t **result)
	Creates a new instance of scanbotsdk_check_scanner_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_free (scanbotsdk_check_scanner_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_check_scanner_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_get_document_detection_mode (scanbotsdk_check_scanner_configuration_t *self, scanbotsdk_check_document_detection_mode_t *document_detection_mode)
	Returns value of document_detection_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_set_document_detection_mode (scanbotsdk_check_scanner_configuration_t *self, scanbotsdk_check_document_detection_mode_t document_detection_mode)
	Sets value of document_detection_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_get_accepted_check_standards (scanbotsdk_check_scanner_configuration_t *self, scanbotsdk_check_standard_t **accepted_check_standards)
	Returns value of accepted_check_standards field of the given object. The returned value is direct view into memory, no pre-allocations needed.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_get_accepted_check_standards_size (scanbotsdk_check_scanner_configuration_t *self, size_t *size)
	Returns size of accepted_check_standards array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_set_accepted_check_standards (scanbotsdk_check_scanner_configuration_t *self, scanbotsdk_check_standard_t *accepted_check_standards, size_t accepted_check_standards_size)
	Sets value of accepted_check_standards field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_get_processing_mode (scanbotsdk_check_scanner_configuration_t *self, scanbotsdk_processing_mode_t *processing_mode)
	Returns value of processing_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_configuration_set_processing_mode (scanbotsdk_check_scanner_configuration_t *self, scanbotsdk_processing_mode_t processing_mode)
	Sets value of processing_mode field of the given object.