ScanbotSDKMultiPageImageExtractorTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_extracted_image_metadata_t	scanbotsdk_extracted_image_metadata_t
	scanbotsdk_extracted_image_metadata_t class
typedef struct scanbotsdk_extracted_image_t	scanbotsdk_extracted_image_t
	scanbotsdk_extracted_image_t class
typedef struct scanbotsdk_extracted_page_t	scanbotsdk_extracted_page_t
	scanbotsdk_extracted_page_t class
typedef struct scanbotsdk_page_extraction_result_t	scanbotsdk_page_extraction_result_t
	scanbotsdk_page_extraction_result_t class

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_image_metadata_create (int height, int width, scanbotsdk_extracted_image_metadata_t **result)
	Creates a new instance of scanbotsdk_extracted_image_metadata with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_image_metadata_free (scanbotsdk_extracted_image_metadata_t *object)
	Frees the memory allocated for the instance of scanbotsdk_extracted_image_metadata_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_image_metadata_get_height (scanbotsdk_extracted_image_metadata_t *self, int *height)
	Returns value of height field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_image_metadata_get_width (scanbotsdk_extracted_image_metadata_t *self, int *width)
	Returns value of width field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_image_free (scanbotsdk_extracted_image_t *object)
	Frees the memory allocated for the instance of scanbotsdk_extracted_image_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_image_get_image (scanbotsdk_extracted_image_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_extracted_image_get_metadata (scanbotsdk_extracted_image_t *self, scanbotsdk_extracted_image_metadata_t **metadata)
	Returns value of metadata 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_extracted_page_free (scanbotsdk_extracted_page_t *object)
	Frees the memory allocated for the instance of scanbotsdk_extracted_page_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_extracted_page_get_images (scanbotsdk_extracted_page_t *self, scanbotsdk_extracted_image_t **images, size_t size)
	Returns value of images 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_extracted_page_get_images_size (scanbotsdk_extracted_page_t *self, size_t *size)
	Returns size of images array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_extraction_result_free (scanbotsdk_page_extraction_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_page_extraction_result_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_extraction_result_get_pages (scanbotsdk_page_extraction_result_t *self, scanbotsdk_extracted_page_t **pages, size_t size)
	Returns value of pages 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_page_extraction_result_get_pages_size (scanbotsdk_page_extraction_result_t *self, size_t *size)
	Returns size of pages array.