ScanbotSDKDocumentCleanupTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef enum scanbotsdk_document_cleanup_status_t	scanbotsdk_document_cleanup_status_t
	scanbotsdk_document_cleanup_status_t enum
typedef struct scanbotsdk_document_cleanup_result_t	scanbotsdk_document_cleanup_result_t
	scanbotsdk_document_cleanup_result_t class
typedef struct scanbotsdk_document_cleanup_configuration_t	scanbotsdk_document_cleanup_configuration_t
	scanbotsdk_document_cleanup_configuration_t class

Enumerations
enum	scanbotsdk_document_cleanup_status_t {   SCANBOTSDK_DOCUMENT_CLEANUP_STATUS_OK = 0 ,   SCANBOTSDK_DOCUMENT_CLEANUP_STATUS_OK_BUT_REDUCED_QUALITY = 1 ,   SCANBOTSDK_DOCUMENT_CLEANUP_STATUS_ERROR_MASK_TOO_LARGE = 2 }
	scanbotsdk_document_cleanup_status_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_status_t_to_string (scanbotsdk_document_cleanup_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_document_cleanup_status_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_result_free (scanbotsdk_document_cleanup_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_cleanup_result_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_result_get_status (scanbotsdk_document_cleanup_result_t *self, scanbotsdk_document_cleanup_status_t *status)
	Returns value of status field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_result_get_image (scanbotsdk_document_cleanup_result_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_document_cleanup_configuration_create (bool keep_text, int max_undo_redo_stack_size, int max_cleanup_resolution, int max_mask_bounding_box_area, scanbotsdk_document_cleanup_configuration_t **result)
	Creates a new instance of scanbotsdk_document_cleanup_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_create_with_defaults (scanbotsdk_document_cleanup_configuration_t **result)
	Creates a new instance of scanbotsdk_document_cleanup_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_free (scanbotsdk_document_cleanup_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_cleanup_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_get_keep_text (scanbotsdk_document_cleanup_configuration_t *self, bool *keep_text)
	Returns value of keep_text field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_set_keep_text (scanbotsdk_document_cleanup_configuration_t *self, bool keep_text)
	Sets value of keep_text field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_get_max_undo_redo_stack_size (scanbotsdk_document_cleanup_configuration_t *self, int *max_undo_redo_stack_size)
	Returns value of max_undo_redo_stack_size field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_set_max_undo_redo_stack_size (scanbotsdk_document_cleanup_configuration_t *self, int max_undo_redo_stack_size)
	Sets value of max_undo_redo_stack_size field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_get_max_cleanup_resolution (scanbotsdk_document_cleanup_configuration_t *self, int *max_cleanup_resolution)
	Returns value of max_cleanup_resolution field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_set_max_cleanup_resolution (scanbotsdk_document_cleanup_configuration_t *self, int max_cleanup_resolution)
	Sets value of max_cleanup_resolution field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_get_max_mask_bounding_box_area (scanbotsdk_document_cleanup_configuration_t *self, int *max_mask_bounding_box_area)
	Returns value of max_mask_bounding_box_area field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_cleanup_configuration_set_max_mask_bounding_box_area (scanbotsdk_document_cleanup_configuration_t *self, int max_mask_bounding_box_area)
	Sets value of max_mask_bounding_box_area field of the given object.