Typedefs
typedef struct scanbotsdk_check_scanner_t	scanbotsdk_check_scanner_t
	scanbotsdk_check_scanner_t class

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_scanner_create (scanbotsdk_check_scanner_configuration_t configuration, scanbotsdk_check_scanner_t *result)
	Creates a new instance of scanbotsdk_check_scanner with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_free (scanbotsdk_check_scanner_t *self)
	Frees the memory allocated for the instance of scanbotsdk_check_scanner_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_check_scanner_run (scanbotsdk_check_scanner_t self, scanbotsdk_image_t image, scanbotsdk_check_scanning_result_t **result)
	Scan check in the given image.

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.

Detailed Description

Typedef Documentation

◆ scanbotsdk_check_document_detection_mode_t

typedef enum scanbotsdk_check_document_detection_mode_t scanbotsdk_check_document_detection_mode_t

scanbotsdk_check_document_detection_mode_t enum

Check document detection and extraction mode.

◆ scanbotsdk_check_magnetic_ink_strip_scanning_status_t

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

Check magnetic ink (MICR) strip scanning status.

◆ scanbotsdk_check_scanner_configuration_t

typedef struct scanbotsdk_check_scanner_configuration_t scanbotsdk_check_scanner_configuration_t

scanbotsdk_check_scanner_configuration_t class

Configuration of the check scanner.

◆ scanbotsdk_check_scanner_t

typedef struct scanbotsdk_check_scanner_t scanbotsdk_check_scanner_t

scanbotsdk_check_scanner_t class

API for check scanning.

Required licence feature(s): CheckScanner.

◆ scanbotsdk_check_scanning_result_t

typedef struct scanbotsdk_check_scanning_result_t scanbotsdk_check_scanning_result_t

scanbotsdk_check_scanning_result_t class

The result of check scanning.

◆ scanbotsdk_check_standard_t

typedef enum scanbotsdk_check_standard_t scanbotsdk_check_standard_t

scanbotsdk_check_standard_t enum

Supported check standards.

Enumeration Type Documentation

◆ scanbotsdk_check_document_detection_mode_t

enum scanbotsdk_check_document_detection_mode_t

scanbotsdk_check_document_detection_mode_t enum

Check document detection and extraction mode.

Enumerator
SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DISABLED	Document detection is not performed. Successful check scans will only contain the machine-readable check data without a full crop of the check.
SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DETECT_DOCUMENT	Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection.
SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DETECT_AND_CROP_DOCUMENT	Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection. The croppedImage result field will contain a crop of the entire check.

◆ scanbotsdk_check_magnetic_ink_strip_scanning_status_t

enum scanbotsdk_check_magnetic_ink_strip_scanning_status_t

scanbotsdk_check_magnetic_ink_strip_scanning_status_t enum

Check magnetic ink (MICR) strip scanning status.

Enumerator
SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_SUCCESS	Scanning successful.
SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_INCOMPLETE_VALIDATION	Magnetic ink strip was found, but validation failed, because of a format violation, an unsupported format, or an OCR error.
SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_ERROR_NOTHING_FOUND	Magnetic ink strip was not found.

◆ scanbotsdk_check_standard_t

enum scanbotsdk_check_standard_t

scanbotsdk_check_standard_t enum

Supported check standards.

Enumerator
SCANBOTSDK_CHECK_STANDARD_USA	A check compatible with the ASC X9 standard used in the USA.
SCANBOTSDK_CHECK_STANDARD_FRA	A check format commonly used in France.
SCANBOTSDK_CHECK_STANDARD_KWT	A check format commonly used in Kuwait.
SCANBOTSDK_CHECK_STANDARD_AUS	A check compatible with the Australian Paper Clearing System cheque standard.
SCANBOTSDK_CHECK_STANDARD_IND	A check compatible with the CTS-2010 standard issued by the Reserve Bank of India in 2012.
SCANBOTSDK_CHECK_STANDARD_ISR	A check format commonly used in Israel.
SCANBOTSDK_CHECK_STANDARD_UAE	A check format commonly used in the United Arab Emirates.
SCANBOTSDK_CHECK_STANDARD_CAN	A check format commonly used in Canada.

Function Documentation

◆ scanbotsdk_check_document_detection_mode_t_to_string()

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.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_magnetic_ink_strip_scanning_status_t_to_string()

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.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanner_configuration_create()

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.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

document_detection_mode Document detection to be performed in addition to scanning the machine-readable data in the check.

By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data. A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.

If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results.

Default is DISABLED

Parameters

accepted_check_standards	Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.
accepted_check_standards_size	Size of the array accepted_check_standards
processing_mode	Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default is AUTO

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_check_scanner_configuration_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_configuration_create_with_defaults()

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.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_check_scanner_configuration_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_configuration_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_check_scanner_configuration_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_configuration_get_accepted_check_standards()

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.

Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t
accepted_check_standards	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanner_configuration_get_accepted_check_standards_size()

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.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t
size	Pointer to a variable that will store the size.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanner_configuration_get_document_detection_mode()

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.

Document detection to be performed in addition to scanning the machine-readable data in the check.

By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data. A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.

If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results.

Default is DISABLED

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t
document_detection_mode	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanner_configuration_get_processing_mode()

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.

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default is AUTO

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t
processing_mode	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanner_configuration_set_accepted_check_standards()

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.

Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t, the field of which will be set
accepted_check_standards	The value to be set.
accepted_check_standards_size	Size of the array.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_configuration_set_document_detection_mode()

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.

Document detection to be performed in addition to scanning the machine-readable data in the check.

By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data. A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.

If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results.

Default is DISABLED

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t, the field of which will be set
document_detection_mode	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_configuration_set_processing_mode()

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.

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default is AUTO

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_configuration_t, the field of which will be set
processing_mode	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_create	(	scanbotsdk_check_scanner_configuration_t *	configuration,
		scanbotsdk_check_scanner_t **	result )

Creates a new instance of scanbotsdk_check_scanner with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

configuration	The configuration to use for the check scanner. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_check_scanner_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_free ( scanbotsdk_check_scanner_t * self )

Frees the memory allocated for the instance of scanbotsdk_check_scanner_t. If null is passed, the function does nothing.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanner_run()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_run	(	scanbotsdk_check_scanner_t *	self,
		scanbotsdk_image_t *	image,
		scanbotsdk_check_scanning_result_t **	result )

Scan check in the given image.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanner_t method to be called on
image	The image to scan check in. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_check_scanner_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanning_result_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_check_scanning_result_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_check_scanning_result_get_check()

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.

Generic document containing check data. Not present, if status is FAIL.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanning_result_t
check	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanning_result_get_cropped_image()

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.

Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanning_result_t
cropped_image	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanning_result_get_document_detection_result()

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.

The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.

Parameters

self	Pointer to the instance of scanbotsdk_check_scanning_result_t
document_detection_result	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_scanning_result_get_status()

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.

Magnetic ink strip scanning status.

Default is ERROR_NOTHING_FOUND

Parameters

self	Pointer to the instance of scanbotsdk_check_scanning_result_t
status	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_check_standard_t_to_string()

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.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ scanbotsdk_check_document_detection_mode_t

◆ scanbotsdk_check_magnetic_ink_strip_scanning_status_t

◆ scanbotsdk_check_scanner_configuration_t

◆ scanbotsdk_check_scanner_t

◆ scanbotsdk_check_scanning_result_t

◆ scanbotsdk_check_standard_t

Enumeration Type Documentation

◆ scanbotsdk_check_document_detection_mode_t

◆ scanbotsdk_check_magnetic_ink_strip_scanning_status_t

◆ scanbotsdk_check_standard_t

Function Documentation

◆ scanbotsdk_check_document_detection_mode_t_to_string()

◆ scanbotsdk_check_magnetic_ink_strip_scanning_status_t_to_string()

◆ scanbotsdk_check_scanner_configuration_create()

◆ scanbotsdk_check_scanner_configuration_create_with_defaults()

◆ scanbotsdk_check_scanner_configuration_free()

◆ scanbotsdk_check_scanner_configuration_get_accepted_check_standards()

◆ scanbotsdk_check_scanner_configuration_get_accepted_check_standards_size()

◆ scanbotsdk_check_scanner_configuration_get_document_detection_mode()

◆ scanbotsdk_check_scanner_configuration_get_processing_mode()

◆ scanbotsdk_check_scanner_configuration_set_accepted_check_standards()

◆ scanbotsdk_check_scanner_configuration_set_document_detection_mode()

◆ scanbotsdk_check_scanner_configuration_set_processing_mode()

◆ scanbotsdk_check_scanner_create()

◆ scanbotsdk_check_scanner_free()

◆ scanbotsdk_check_scanner_run()

◆ scanbotsdk_check_scanning_result_free()

◆ scanbotsdk_check_scanning_result_get_check()

◆ scanbotsdk_check_scanning_result_get_cropped_image()

◆ scanbotsdk_check_scanning_result_get_document_detection_result()

◆ scanbotsdk_check_scanning_result_get_status()

◆ scanbotsdk_check_standard_t_to_string()