ScanbotSDKPdfConfigurationTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_pdf_attributes_t	scanbotsdk_pdf_attributes_t
	scanbotsdk_pdf_attributes_t class
typedef enum scanbotsdk_page_size_t	scanbotsdk_page_size_t
	scanbotsdk_page_size_t enum
typedef enum scanbotsdk_page_direction_t	scanbotsdk_page_direction_t
	scanbotsdk_page_direction_t enum
typedef enum scanbotsdk_page_fit_t	scanbotsdk_page_fit_t
	scanbotsdk_page_fit_t enum
typedef enum scanbotsdk_resampling_method_t	scanbotsdk_resampling_method_t
	scanbotsdk_resampling_method_t enum
typedef struct scanbotsdk_pdf_configuration_t	scanbotsdk_pdf_configuration_t
	scanbotsdk_pdf_configuration_t class

Enumerations
enum	scanbotsdk_page_size_t {   SCANBOTSDK_PAGE_SIZE_LETTER = 0 ,   SCANBOTSDK_PAGE_SIZE_LEGAL = 1 ,   SCANBOTSDK_PAGE_SIZE_A3 = 2 ,   SCANBOTSDK_PAGE_SIZE_A4 = 3 ,   SCANBOTSDK_PAGE_SIZE_A5 = 4 ,   SCANBOTSDK_PAGE_SIZE_B4 = 5 ,   SCANBOTSDK_PAGE_SIZE_B5 = 6 ,   SCANBOTSDK_PAGE_SIZE_EXECUTIVE = 7 ,   SCANBOTSDK_PAGE_SIZE_US4x6 = 8 ,   SCANBOTSDK_PAGE_SIZE_US4x8 = 9 ,   SCANBOTSDK_PAGE_SIZE_US5x7 = 10 ,   SCANBOTSDK_PAGE_SIZE_COMM10 = 11 ,   SCANBOTSDK_PAGE_SIZE_CUSTOM = 12 }
	scanbotsdk_page_size_t enum More...
enum	scanbotsdk_page_direction_t {   SCANBOTSDK_PAGE_DIRECTION_PORTRAIT = 0 ,   SCANBOTSDK_PAGE_DIRECTION_LANDSCAPE = 1 ,   SCANBOTSDK_PAGE_DIRECTION_AUTO = 2 }
	scanbotsdk_page_direction_t enum More...
enum	scanbotsdk_page_fit_t {   SCANBOTSDK_PAGE_FIT_FIT_IN = 0 ,   SCANBOTSDK_PAGE_FIT_FILL_IN = 1 ,   SCANBOTSDK_PAGE_FIT_STRETCH = 2 ,   SCANBOTSDK_PAGE_FIT_NONE = 3 }
	scanbotsdk_page_fit_t enum More...
enum	scanbotsdk_resampling_method_t {   SCANBOTSDK_RESAMPLING_METHOD_NONE = 0 ,   SCANBOTSDK_RESAMPLING_METHOD_NEAREST = 1 ,   SCANBOTSDK_RESAMPLING_METHOD_LINEAR = 2 ,   SCANBOTSDK_RESAMPLING_METHOD_CUBIC = 3 ,   SCANBOTSDK_RESAMPLING_METHOD_LANCZOS4 = 4 ,   SCANBOTSDK_RESAMPLING_METHOD_AREA = 5 }
	scanbotsdk_resampling_method_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_create (const char *author, const char *creator, const char *title, const char *subject, const char *keywords, scanbotsdk_pdf_attributes_t **result)
	Creates a new instance of scanbotsdk_pdf_attributes with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_create_with_defaults (scanbotsdk_pdf_attributes_t **result)
	Creates a new instance of scanbotsdk_pdf_attributes_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_free (scanbotsdk_pdf_attributes_t *object)
	Frees the memory allocated for the instance of scanbotsdk_pdf_attributes_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_get_author (scanbotsdk_pdf_attributes_t *self, const char **author)
	Returns value of author 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_pdf_attributes_set_author (scanbotsdk_pdf_attributes_t *self, const char *author)
	Sets value of author field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_get_creator (scanbotsdk_pdf_attributes_t *self, const char **creator)
	Returns value of creator 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_pdf_attributes_set_creator (scanbotsdk_pdf_attributes_t *self, const char *creator)
	Sets value of creator field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_get_title (scanbotsdk_pdf_attributes_t *self, const char **title)
	Returns value of title 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_pdf_attributes_set_title (scanbotsdk_pdf_attributes_t *self, const char *title)
	Sets value of title field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_get_subject (scanbotsdk_pdf_attributes_t *self, const char **subject)
	Returns value of subject 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_pdf_attributes_set_subject (scanbotsdk_pdf_attributes_t *self, const char *subject)
	Sets value of subject field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_attributes_get_keywords (scanbotsdk_pdf_attributes_t *self, const char **keywords)
	Returns value of keywords 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_pdf_attributes_set_keywords (scanbotsdk_pdf_attributes_t *self, const char *keywords)
	Sets value of keywords field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_size_t_to_string (scanbotsdk_page_size_t value, const char **result)
	Returns the string representation of the given scanbotsdk_page_size_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_direction_t_to_string (scanbotsdk_page_direction_t value, const char **result)
	Returns the string representation of the given scanbotsdk_page_direction_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_fit_t_to_string (scanbotsdk_page_fit_t value, const char **result)
	Returns the string representation of the given scanbotsdk_page_fit_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_resampling_method_t_to_string (scanbotsdk_resampling_method_t value, const char **result)
	Returns the string representation of the given scanbotsdk_resampling_method_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_create (scanbotsdk_pdf_attributes_t *attributes, scanbotsdk_page_size_t page_size, scanbotsdk_page_direction_t page_direction, scanbotsdk_page_fit_t page_fit, int dpi, int jpeg_quality, scanbotsdk_resampling_method_t resampling_method, scanbotsdk_parametric_filter_t *binarization_filter, scanbotsdk_pdf_configuration_t **result)
	Creates a new instance of scanbotsdk_pdf_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_create_with_defaults (scanbotsdk_pdf_configuration_t **result)
	Creates a new instance of scanbotsdk_pdf_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_free (scanbotsdk_pdf_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_pdf_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_attributes (scanbotsdk_pdf_configuration_t *self, scanbotsdk_pdf_attributes_t **attributes)
	Returns value of attributes 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_pdf_configuration_set_attributes (scanbotsdk_pdf_configuration_t *self, scanbotsdk_pdf_attributes_t *attributes)
	Sets value of attributes field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_page_size (scanbotsdk_pdf_configuration_t *self, scanbotsdk_page_size_t *page_size)
	Returns value of page_size field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_set_page_size (scanbotsdk_pdf_configuration_t *self, scanbotsdk_page_size_t page_size)
	Sets value of page_size field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_page_direction (scanbotsdk_pdf_configuration_t *self, scanbotsdk_page_direction_t *page_direction)
	Returns value of page_direction field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_set_page_direction (scanbotsdk_pdf_configuration_t *self, scanbotsdk_page_direction_t page_direction)
	Sets value of page_direction field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_page_fit (scanbotsdk_pdf_configuration_t *self, scanbotsdk_page_fit_t *page_fit)
	Returns value of page_fit field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_set_page_fit (scanbotsdk_pdf_configuration_t *self, scanbotsdk_page_fit_t page_fit)
	Sets value of page_fit field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_dpi (scanbotsdk_pdf_configuration_t *self, int *dpi)
	Returns value of dpi field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_set_dpi (scanbotsdk_pdf_configuration_t *self, int dpi)
	Sets value of dpi field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_jpeg_quality (scanbotsdk_pdf_configuration_t *self, int *jpeg_quality)
	Returns value of jpeg_quality field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_set_jpeg_quality (scanbotsdk_pdf_configuration_t *self, int jpeg_quality)
	Sets value of jpeg_quality field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_resampling_method (scanbotsdk_pdf_configuration_t *self, scanbotsdk_resampling_method_t *resampling_method)
	Returns value of resampling_method field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_set_resampling_method (scanbotsdk_pdf_configuration_t *self, scanbotsdk_resampling_method_t resampling_method)
	Sets value of resampling_method field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_pdf_configuration_get_binarization_filter (scanbotsdk_pdf_configuration_t *self, scanbotsdk_parametric_filter_t **binarization_filter)
	Returns value of binarization_filter 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_pdf_configuration_set_binarization_filter (scanbotsdk_pdf_configuration_t *self, scanbotsdk_parametric_filter_t *binarization_filter)
	Sets value of binarization_filter field of the given object.