ScanbotSDKTiffTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef enum scanbotsdk_compression_mode_t	scanbotsdk_compression_mode_t
	scanbotsdk_compression_mode_t enum
typedef struct scanbotsdk_user_field_value_t	scanbotsdk_user_field_value_t
	scanbotsdk_user_field_value_t class
typedef struct scanbotsdk_user_field_double_value_t	scanbotsdk_user_field_double_value_t
	scanbotsdk_user_field_double_value_t class
typedef struct scanbotsdk_user_field_string_value_t	scanbotsdk_user_field_string_value_t
	scanbotsdk_user_field_string_value_t class
typedef struct scanbotsdk_user_field_int_value_t	scanbotsdk_user_field_int_value_t
	scanbotsdk_user_field_int_value_t class
typedef struct scanbotsdk_user_field_t	scanbotsdk_user_field_t
	scanbotsdk_user_field_t class
typedef struct scanbotsdk_tiff_generator_parameters_t	scanbotsdk_tiff_generator_parameters_t
	scanbotsdk_tiff_generator_parameters_t class

Enumerations
enum	scanbotsdk_compression_mode_t {   SCANBOTSDK_COMPRESSION_MODE_NONE = 1 ,   SCANBOTSDK_COMPRESSION_MODE_CCITTRLE = 2 ,   SCANBOTSDK_COMPRESSION_MODE_CCITT_T4 = 3 ,   SCANBOTSDK_COMPRESSION_MODE_CCITT_T6 = 4 ,   SCANBOTSDK_COMPRESSION_MODE_LZW = 5 ,   SCANBOTSDK_COMPRESSION_MODE_JPEG = 7 ,   SCANBOTSDK_COMPRESSION_MODE_CCITTRLEW = 32771 ,   SCANBOTSDK_COMPRESSION_MODE_PACKBITS = 32773 ,   SCANBOTSDK_COMPRESSION_MODE_DEFLATE = 32946 ,   SCANBOTSDK_COMPRESSION_MODE_ADOBE_DEFLATE = 8 }
	scanbotsdk_compression_mode_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_compression_mode_t_to_string (scanbotsdk_compression_mode_t value, const char **result)
	Returns the string representation of the given scanbotsdk_compression_mode_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_free (scanbotsdk_user_field_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_value_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_create (double value, scanbotsdk_user_field_double_value_t **result)
	Creates a new instance of scanbotsdk_user_field_double_value with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_free (scanbotsdk_user_field_double_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_double_value_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_is_scanbotsdk_user_field_double_value (scanbotsdk_user_field_value_t *object, bool *result)
	Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_double_value_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_as_scanbotsdk_user_field_double_value (scanbotsdk_user_field_value_t *object, scanbotsdk_user_field_double_value_t **result)
	Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_double_value_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_as_scanbotsdk_user_field_value (scanbotsdk_user_field_double_value_t *object, scanbotsdk_user_field_value_t **result)
	Casts the given instance of scanbotsdk_user_field_double_value_t to its parent type scanbotsdk_user_field_value_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_get_value (scanbotsdk_user_field_double_value_t *self, double *value)
	Returns value of value field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_set_value (scanbotsdk_user_field_double_value_t *self, double value)
	Sets value of value field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_create (const char *value, scanbotsdk_user_field_string_value_t **result)
	Creates a new instance of scanbotsdk_user_field_string_value with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_free (scanbotsdk_user_field_string_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_string_value_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_is_scanbotsdk_user_field_string_value (scanbotsdk_user_field_value_t *object, bool *result)
	Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_string_value_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_as_scanbotsdk_user_field_string_value (scanbotsdk_user_field_value_t *object, scanbotsdk_user_field_string_value_t **result)
	Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_string_value_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_as_scanbotsdk_user_field_value (scanbotsdk_user_field_string_value_t *object, scanbotsdk_user_field_value_t **result)
	Casts the given instance of scanbotsdk_user_field_string_value_t to its parent type scanbotsdk_user_field_value_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_get_value (scanbotsdk_user_field_string_value_t *self, const char **value)
	Returns value of value 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_user_field_string_value_set_value (scanbotsdk_user_field_string_value_t *self, const char *value)
	Sets value of value field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_create (int value, scanbotsdk_user_field_int_value_t **result)
	Creates a new instance of scanbotsdk_user_field_int_value with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_free (scanbotsdk_user_field_int_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_int_value_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_is_scanbotsdk_user_field_int_value (scanbotsdk_user_field_value_t *object, bool *result)
	Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_int_value_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_as_scanbotsdk_user_field_int_value (scanbotsdk_user_field_value_t *object, scanbotsdk_user_field_int_value_t **result)
	Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_int_value_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_as_scanbotsdk_user_field_value (scanbotsdk_user_field_int_value_t *object, scanbotsdk_user_field_value_t **result)
	Casts the given instance of scanbotsdk_user_field_int_value_t to its parent type scanbotsdk_user_field_value_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_get_value (scanbotsdk_user_field_int_value_t *self, int *value)
	Returns value of value field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_set_value (scanbotsdk_user_field_int_value_t *self, int value)
	Sets value of value field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_create (int tag, const char *name, scanbotsdk_user_field_value_t *value, scanbotsdk_user_field_t **result)
	Creates a new instance of scanbotsdk_user_field with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_free (scanbotsdk_user_field_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_get_tag (scanbotsdk_user_field_t *self, int *tag)
	Returns value of tag field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_set_tag (scanbotsdk_user_field_t *self, int tag)
	Sets value of tag field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_get_name (scanbotsdk_user_field_t *self, const char **name)
	Returns value of name 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_user_field_set_name (scanbotsdk_user_field_t *self, const char *name)
	Sets value of name field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_get_value (scanbotsdk_user_field_t *self, scanbotsdk_user_field_value_t **value)
	Returns value of value 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_user_field_set_value (scanbotsdk_user_field_t *self, scanbotsdk_user_field_value_t *value)
	Sets value of value field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_create (scanbotsdk_compression_mode_t compression, int jpeg_quality, int zip_compression_level, int dpi, scanbotsdk_user_field_t **user_fields, size_t user_fields_size, scanbotsdk_parametric_filter_t *binarization_filter, scanbotsdk_tiff_generator_parameters_t **result)
	Creates a new instance of scanbotsdk_tiff_generator_parameters with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_create_with_defaults (scanbotsdk_tiff_generator_parameters_t **result)
	Creates a new instance of scanbotsdk_tiff_generator_parameters_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_free (scanbotsdk_tiff_generator_parameters_t *object)
	Frees the memory allocated for the instance of scanbotsdk_tiff_generator_parameters_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_compression (scanbotsdk_tiff_generator_parameters_t *self, scanbotsdk_compression_mode_t *compression)
	Returns value of compression field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_compression (scanbotsdk_tiff_generator_parameters_t *self, scanbotsdk_compression_mode_t compression)
	Sets value of compression field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_jpeg_quality (scanbotsdk_tiff_generator_parameters_t *self, int *jpeg_quality)
	Returns value of jpeg_quality field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_jpeg_quality (scanbotsdk_tiff_generator_parameters_t *self, int jpeg_quality)
	Sets value of jpeg_quality field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_zip_compression_level (scanbotsdk_tiff_generator_parameters_t *self, int *zip_compression_level)
	Returns value of zip_compression_level field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_zip_compression_level (scanbotsdk_tiff_generator_parameters_t *self, int zip_compression_level)
	Sets value of zip_compression_level field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_dpi (scanbotsdk_tiff_generator_parameters_t *self, int *dpi)
	Returns value of dpi field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_dpi (scanbotsdk_tiff_generator_parameters_t *self, int dpi)
	Sets value of dpi field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_user_fields (scanbotsdk_tiff_generator_parameters_t *self, scanbotsdk_user_field_t **user_fields, size_t size)
	Returns value of user_fields 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_tiff_generator_parameters_get_user_fields_size (scanbotsdk_tiff_generator_parameters_t *self, size_t *size)
	Returns size of user_fields array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_user_fields (scanbotsdk_tiff_generator_parameters_t *self, scanbotsdk_user_field_t **user_fields, size_t user_fields_size)
	Sets value of user_fields field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_binarization_filter (scanbotsdk_tiff_generator_parameters_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_tiff_generator_parameters_set_binarization_filter (scanbotsdk_tiff_generator_parameters_t *self, scanbotsdk_parametric_filter_t *binarization_filter)
	Sets value of binarization_filter field of the given object.